fix boolean-as-categorical support (#327)

* fix boolean-as-categorical support

* ignore versioned manifests

* fix method ambiguity

---------

Co-authored-by: Alex Arslan <[email protected]>

Author: palday

.gitignore

@@ -3,3 +3,4 @@
 *.jl.mem
 docs/build
 Manifest.toml
+Manifest-v*.toml

Project.toml

@@ -1,6 +1,6 @@
 name = "StatsModels"
 uuid = "3eaba693-59b7-5ba5-a881-562e759f1c8d"
-version = "0.7.5"
+version = "0.7.6"
 
 [deps]
 DataAPI = "9a962f9c-6df0-11e9-0e5d-c546b8b5ee8a"

src/contrasts.jl

@@ -233,6 +233,12 @@ function StatsAPI.coefnames(C::AbstractContrasts, levels::AbstractVector, basein
     DataAPI.unwrap.(levels[not_base])
 end
 
+function StatsAPI.coefnames(C::AbstractContrasts, levels::AbstractVector{Bool}, baseind::Integer)
+    not_base = [firstindex(levels):(baseind - 1); (baseind + 1):lastindex(levels)]
+    # broadcasted DataAPI.unwrap converts Vector{Bool} to BitVector
+    convert(Vector{Bool}, DataAPI.unwrap.(levels[not_base]))
+end
+
 Base.getindex(contrasts::ContrastsMatrix, rowinds, colinds) =
     getindex(contrasts.matrix, getindex.(Ref(contrasts.invindex), rowinds), colinds)
 
@@ -598,6 +604,10 @@ end
 StatsAPI.coefnames(C::HypothesisCoding, levels::AbstractVector, baseind::Int) =
     something(C.labels, DataAPI.unwrap.(levels[1:length(levels) .!= baseind]))
 
+# We need an explicit method for `AbstractVector{Bool}` to avoid an ambiguity
+StatsAPI.coefnames(C::HypothesisCoding, levels::AbstractVector{Bool}, baseind::Int) =
+    something(C.labels, DataAPI.unwrap.(levels[1:length(levels) .!= baseind]))
+
 DataAPI.levels(c::HypothesisCoding) = c.levels
 
 """

test/contrasts.jl

@@ -1,7 +1,7 @@
 @testset "contrasts" begin
 
     cm = StatsModels.ContrastsMatrix(DummyCoding(), ["a", "b"])
-    @test_logs((:warn, 
+    @test_logs((:warn,
                 "The `termnames` field of `ConstrastsMatrix` is deprecated; use `coefnames(cm)` instead."),
                cm.termnames)
     @test cm.termnames == cm.coefnames
@@ -87,9 +87,9 @@
                                 1 -1 -1
                                 1  0  1]
     @test coefnames(mf) == ["(Intercept)"; "x: c"; "x: b"]
-    
+
     # respect order of levels
-    
+
     data = DataFrame(x = levels!(categorical(['A', 'B', 'C', 'C', 'D']), ['C', 'B', 'A', 'D']))
     f = apply_schema(@formula(x ~ 1), schema(data))
     @test modelcols(f.lhs, data) == [0 1 0; 1 0 0; 0 0 0; 0 0 0; 0 0 1]
@@ -239,7 +239,7 @@
         f_effects = apply_schema(f, schema(d2, Dict(:x => effects_hyp)))
 
         y_means = combine(groupby(d2, :x), :y => mean).y_mean
-        
+
         y, X_sdiff = modelcols(f_sdiff, d2)
         @test X_sdiff \ y ≈ [mean(y_means); diff(y_means)]
 
@@ -271,18 +271,18 @@
             [0 1 0 0
              0 0 1 0
              0 0 0 1]
-        
+
 
         cmat2 = contrasts_matrix(HelmertCoding(), 1, 4)
         @test needs_intercept(cmat2) == false
-        hmat2 = hypothesis_matrix(cmat2) 
+        hmat2 = hypothesis_matrix(cmat2)
         @test hmat2 ≈
             [-1/2   1/2   0    0
              -1/6  -1/6   1/3  0
              -1/12 -1/12 -1/12 1/4]
 
         @test eltype(hmat2) <: Rational
-        
+
         @test hypothesis_matrix(cmat2, intercept=true) ≈
             vcat([1/4 1/4 1/4 1/4], hmat2)
 
@@ -350,7 +350,7 @@
         @test levels(c) == levs
         # no notion of base level for ContrastsCoding
         @test_throws MethodError ContrastsCoding(rand(4,3), base=base)
-        
+
     end
 
     @testset "Non-unique levels" begin
@@ -396,10 +396,26 @@
 
         mm = modelcols(term, (; x=repeat('a':'d'; inner=2)))
         smm = modelcols(spterm, (; x=repeat('a':'d'; inner=2)))
-        
+
         @test mm isa Matrix
         @test smm isa SparseMatrixCSC
         @test mm == smm
     end
-    
+
+    @testset "booleans as categorical" begin
+        cm = ContrastsMatrix(EffectsCoding(), [true, false])
+        @test cm.coefnames == [false]
+        @test issetequal(cm.levels, [true, false])
+
+        hypothesis = [0 1]'
+        cm = ContrastsMatrix(EffectsCoding(), [true, false])
+        @test cm.coefnames == [false]
+        @test issetequal(cm.levels, [true, false])
+
+        hc = HypothesisCoding([1 0]; levels=[true, false], labels=["yes", "no"])
+        cm = ContrastsMatrix(hc, [true, false])
+        @test issetequal(cm.coefnames, ["yes", "no"])
+        @test issetequal(cm.levels, [true, false])
+    end
+
 end