Substitutions when all missing (#107)

* Throw debug messages when substitution aren't possible when all values are missing.

* Bump patch release version.

* Apply suggestions from code review

Co-authored-by: Glenn Moynihan <[email protected]>

* Test log message instead.

Co-authored-by: Glenn Moynihan <[email protected]>

Project.toml

@@ -1,7 +1,7 @@
 name = "Impute"
 uuid = "f7bf1975-0170-51b9-8c5f-a992d46b9575"
 authors = ["Invenia Technical Computing"]
-version = "0.6.2"
+version = "0.6.3"
 
 [deps]
 BSON = "fbb218c0-5317-5bc6-957e-2ee96dd4b1f0"

src/imputors/substitute.jl

@@ -37,8 +37,18 @@ Substitute(; statistic=defaultstats) = Substitute(statistic)
 
 function _impute!(data::AbstractArray{Union{T, Missing}}, imp::Substitute) where T
     mask = .!ismissing.(data)
-    x = imp.statistic(disallowmissing(data[mask]))
-    return Base.replace!(data, missing => x)
+    # Since most summary statistics will require some data, we throw a debug message when
+    # all supplied values are missing
+    if any(mask)
+        x = imp.statistic(disallowmissing(data[mask]))
+        return Base.replace!(data, missing => x)
+    else
+        @warn(
+            "Cannot apply substitution function ($(imp.statistic)) " *
+            "when all values are missing"
+        )
+        return data
+    end
 end
 
 
@@ -82,8 +92,19 @@ end
 
 function _impute!(data::AbstractArray{Union{T, Missing}}, imp::WeightedSubstitute) where T
     mask = .!ismissing.(data)
-    x = imp.statistic(disallowmissing(data[mask]), imp.weights[mask])
-    return Base.replace!(data, missing => x)
+
+    # Since most summary statistics will require some data, we throw a debug message when
+    # all supplied values are missing
+    if any(mask)
+        x = imp.statistic(disallowmissing(data[mask]), imp.weights[mask])
+        return Base.replace!(data, missing => x)
+    else
+        @warn(
+            "Cannot apply weighted substitution function ($(imp.statistic)) " *
+            "when all values are missing"
+        )
+        return data
+    end
 end
 
 # Auxiliary functions defining our default substitution rules

test/imputors/substitute.jl

@@ -102,6 +102,11 @@
         )
         @test result == expected
     end
+
+    @testset "all missing" begin
+        a = [missing 2; missing 3]
+        @test_logs (:warn, r"all values are missing") Impute.substitute(a; dims=2)
+    end
 end
 
 @testset "WeightedSubstitute" begin
@@ -220,4 +225,9 @@ end
         )
         @test result == expected
     end
+
+    @testset "all missing" begin
+        a = [missing 2; missing 3]
+        @test_logs (:warn, r"all values are missing") Impute.substitute(a; dims=2)
+    end
 end