Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new scientific conversion: Number to Categorical #7

Merged
merged 1 commit into from
Oct 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion ext/SciTypesDynamicQuantitiesExt.jl
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
module SciTypesDynamicQuantitiesExt

using SciTypes
using DynamicQuantities: AbstractQuantity
using DynamicQuantities: AbstractQuantity, Quantity

SciTypes.scitype(::Type{<:AbstractQuantity{T}}) where {T} = scitype(T)
SciTypes.sciconvert(::Type{SciTypes.Continuous}, x::AbstractQuantity{<:Integer}) = float(x)
SciTypes.sciconvert(::Type{SciTypes.Categorical}, x::AbstractQuantity{<:Number}) = convert(Quantity{Int}, x)
SciTypes.sciconvert(::Type{SciTypes.Categorical}, x::AbstractQuantity{<:Integer}) = x

end
4 changes: 3 additions & 1 deletion ext/SciTypesUnitfulExt.jl
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
module SciTypesUnitfulExt

using SciTypes
using Unitful: AbstractQuantity
using Unitful: AbstractQuantity, Quantity

SciTypes.scitype(::Type{<:AbstractQuantity{T}}) where {T} = scitype(T)
SciTypes.sciconvert(::Type{SciTypes.Continuous}, x::AbstractQuantity{<:Integer}) = float(x)
SciTypes.sciconvert(::Type{SciTypes.Categorical}, x::AbstractQuantity{<:Number}) = convert(Quantity{Int}, x)
SciTypes.sciconvert(::Type{SciTypes.Categorical}, x::AbstractQuantity{<:Integer}) = x

end
2 changes: 2 additions & 0 deletions src/SciTypes.jl
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,8 @@ scitype(::Type{Union{T,Missing}}) where {T} = scitype(T)

sciconvert(::Type{<:SciType}, ::Missing) = missing
sciconvert(::Type{Continuous}, x::Integer) = float(x)
sciconvert(::Type{Categorical}, x::Number) = convert(Int, x)
sciconvert(::Type{Categorical}, x::Integer) = x

#-----------
# UTILITIES
Expand Down
54 changes: 47 additions & 7 deletions test/runtests.jl
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ using Test
end

# fallback: Categorical
for x in (1, 'a', "a")
for x in ('a', "a")
@test SciTypes.sciconvert(SciTypes.Categorical, x) === x
@test scitype(SciTypes.sciconvert(SciTypes.Categorical, x)) <: SciTypes.Categorical
end
Expand All @@ -74,10 +74,18 @@ using Test
@test SciTypes.sciconvert(SciTypes.Unknown, nothing) === nothing
@test scitype(SciTypes.sciconvert(SciTypes.Unknown, nothing)) <: SciTypes.Unknown

# interger to Continuous
@test SciTypes.sciconvert(SciTypes.Continuous, 1) == 1.0
# Interger to Continuous
@test SciTypes.sciconvert(SciTypes.Continuous, 1) === 1.0
@test scitype(SciTypes.sciconvert(SciTypes.Continuous, 1)) <: SciTypes.Continuous

# Number to Categorical
@test SciTypes.sciconvert(SciTypes.Categorical, 1.0) === 1
@test scitype(SciTypes.sciconvert(SciTypes.Categorical, 1.0)) <: SciTypes.Categorical

# no conversion: Integer to Categorical
@test SciTypes.sciconvert(SciTypes.Categorical, Int32(1)) === Int32(1)
@test scitype(SciTypes.sciconvert(SciTypes.Categorical, Int32(1))) <: SciTypes.Categorical

# throws
@test_throws ArgumentError SciTypes.sciconvert(SciTypes.Continuous, nothing)
end
Expand All @@ -87,6 +95,10 @@ using Test
@test elscitype(SciTypes.coerce(SciTypes.Continuous, [1, 2, 3])) <: SciTypes.Continuous
@test SciTypes.coerce(SciTypes.Continuous, (1, 2, 3)) == (1.0, 2.0, 3.0)
@test elscitype(SciTypes.coerce(SciTypes.Continuous, (1, 2, 3))) <: SciTypes.Continuous
@test SciTypes.coerce(SciTypes.Categorical, [1.0, 2.0, 3.0]) == [1, 2, 3]
@test elscitype(SciTypes.coerce(SciTypes.Categorical, [1.0, 2.0, 3.0])) <: SciTypes.Categorical
@test SciTypes.coerce(SciTypes.Categorical, (1.0, 2.0, 3.0)) == (1, 2, 3)
@test elscitype(SciTypes.coerce(SciTypes.Categorical, (1.0, 2.0, 3.0))) <: SciTypes.Categorical
end

@testset "isordered" begin
Expand All @@ -106,6 +118,9 @@ using Test
@test elscitype([1.0, missing, 3.0]) <: SciTypes.Continuous
@test elscitype([1, missing, 3]) <: SciTypes.Categorical
@test isequal(SciTypes.coerce(SciTypes.Continuous, [1, missing, 3]), [1.0, missing, 3.0])
@test elscitype(SciTypes.coerce(SciTypes.Continuous, [1, missing, 3])) <: SciTypes.Continuous
@test isequal(SciTypes.coerce(SciTypes.Categorical, [1.0, missing, 3.0]), [1, missing, 3])
@test elscitype(SciTypes.coerce(SciTypes.Categorical, [1.0, missing, 3.0])) <: SciTypes.Categorical
end

@testset "CoDa" begin
Expand Down Expand Up @@ -134,12 +149,24 @@ using Test
@test elscitype([1.0, 2.0, 3.0] * u) <: SciTypes.Continuous
@test elscitype([1, missing, 3] * u) <: SciTypes.Categorical
@test elscitype([1.0, missing, 3.0] * u) <: SciTypes.Continuous
@test SciTypes.sciconvert(SciTypes.Continuous, q1) == 1.0 * u
@test scitype(SciTypes.sciconvert(SciTypes.Continuous, q1)) <: SciTypes.Continuous
# Quantity{Interger} to Continuous
@test SciTypes.sciconvert(SciTypes.Continuous, 1 * u) === 1.0 * u
@test scitype(SciTypes.sciconvert(SciTypes.Continuous, 1 * u)) <: SciTypes.Continuous
# Quantity{Number} to Categorical
@test SciTypes.sciconvert(SciTypes.Categorical, 1.0 * u) === 1 * u
@test scitype(SciTypes.sciconvert(SciTypes.Categorical, 1.0 * u)) <: SciTypes.Categorical
# no conversion: Quantity{Interger} to Categorical
@test SciTypes.sciconvert(SciTypes.Categorical, Int32(1) * u) === Int32(1) * u
@test scitype(SciTypes.sciconvert(SciTypes.Categorical, Int32(1) * u)) <: SciTypes.Categorical
# coercion
@test SciTypes.coerce(SciTypes.Continuous, [1, 2, 3] * u) == [1.0, 2.0, 3.0] * u
@test elscitype(SciTypes.coerce(SciTypes.Continuous, [1, 2, 3] * u)) <: SciTypes.Continuous
@test isequal(SciTypes.coerce(SciTypes.Continuous, [1, missing, 3] * u), [1.0, missing, 3.0] * u)
@test elscitype(SciTypes.coerce(SciTypes.Continuous, [1, missing, 3] * u)) <: SciTypes.Continuous
@test SciTypes.coerce(SciTypes.Categorical, [1.0, 2.0, 3.0] * u) == [1, 2, 3] * u
@test elscitype(SciTypes.coerce(SciTypes.Categorical, [1.0, 2.0, 3.0] * u)) <: SciTypes.Categorical
@test isequal(SciTypes.coerce(SciTypes.Categorical, [1.0, missing, 3.0] * u), [1, missing, 3] * u)
@test elscitype(SciTypes.coerce(SciTypes.Categorical, [1.0, missing, 3.0] * u)) <: SciTypes.Categorical
end

@testset "DynamicQuantities" begin
Expand All @@ -159,12 +186,25 @@ using Test
@test elscitype([1.0, 2.0, 3.0] .* uf) <: SciTypes.Continuous
@test elscitype([1 * ui, missing, 3 * ui]) <: SciTypes.Categorical
@test elscitype([1.0 * uf, missing, 3.0 * uf]) <: SciTypes.Continuous
@test SciTypes.sciconvert(SciTypes.Continuous, q1) == 1.0 * uf
@test scitype(SciTypes.sciconvert(SciTypes.Continuous, q1)) <: SciTypes.Continuous
# Quantity{Interger} to Continuous
@test SciTypes.sciconvert(SciTypes.Continuous, 1 * ui) === 1.0 * uf
@test scitype(SciTypes.sciconvert(SciTypes.Continuous, 1 * ui)) <: SciTypes.Continuous
# Quantity{Number} to Categorical
@test SciTypes.sciconvert(SciTypes.Categorical, 1.0 * uf) === 1 * ui
@test scitype(SciTypes.sciconvert(SciTypes.Categorical, 1.0 * uf)) <: SciTypes.Categorical
# no conversion: Quantity{Interger} to Categorical
q3 = DynamicQuantities.Quantity{Int32}(q1)
@test SciTypes.sciconvert(SciTypes.Categorical, q3) === q3
@test scitype(SciTypes.sciconvert(SciTypes.Categorical, q3)) <: SciTypes.Categorical
# coercion
@test SciTypes.coerce(SciTypes.Continuous, [1, 2, 3] .* ui) == [1.0, 2.0, 3.0] .* uf
@test elscitype(SciTypes.coerce(SciTypes.Continuous, [1, 2, 3] .* ui)) <: SciTypes.Continuous
@test isequal(SciTypes.coerce(SciTypes.Continuous, [1 * ui, missing, 3 * ui]), [1.0 * uf, missing, 3.0 * uf])
@test elscitype(SciTypes.coerce(SciTypes.Continuous, [1 * ui, missing, 3 * ui])) <: SciTypes.Continuous
@test SciTypes.coerce(SciTypes.Categorical, [1.0, 2.0, 3.0] .* uf) == [1, 2, 3] .* ui
@test elscitype(SciTypes.coerce(SciTypes.Categorical, [1.0, 2.0, 3.0] .* uf)) <: SciTypes.Categorical
@test isequal(SciTypes.coerce(SciTypes.Categorical, [1.0 * uf, missing, 3.0 * uf]), [1 * ui, missing, 3 * ui])
@test elscitype(SciTypes.coerce(SciTypes.Categorical, [1.0 * uf, missing, 3.0 * uf])) <: SciTypes.Categorical
end

@testset "CategoricalArrays" begin
Expand Down