BoxCox.jl Documentation

BoxCox.jl is a Julia package providing an implementation of the Box-Cox transformation and generalizations thereof.

Box-Cox transformations of an unconditional distribution

First, we consider applying the Box-Cox transformation to an unconditional distribution. In other words, we have a vector of data that we wish to be more Gaussian in shape.

We start with the square root of a normal distribution.

using BoxCox
using CairoMakie
using Random
CairoMakie.activate!(; type="svg")

x = abs2.(randn(MersenneTwister(42), 1000))
let f = Figure()
    ax = Axis(f[1,1]; xlabel="x", ylabel="density")
    density!(ax, x)
    ax = Axis(f[1,2]; xlabel="theoretical quantiles", ylabel="observed values")
    qqnorm!(ax, x)
    colsize!(f.layout, 1, Aspect(1, 1.0))
    colsize!(f.layout, 2, Aspect(1, 1.0))
    resize_to_layout!(f)
    f
end
Example block output

We fit the Box-Cox transform.

bc = fit(BoxCoxTransformation, x)
Box-Cox transformation

estimated λ: 0.2073
resultant transformation:

 y^0.2 - 1
-----------
    0.2

Note that the resulting transform isn't exactly a square root, even though our data are just the square of a normal sample. The reason for this is simple: without knowing the original sign, the square root returns all positive values and would thus not generate a symmetric distribution. The Box-Cox transformation does not eliminate the use of the analyst's discretion and domain knowledge.

Now that we've fit the transform, we use it like a function to transform the original data.

let f = Figure(), bcx = bc.(x)
    ax = Axis(f[1,1]; xlabel="x", ylabel="density")
    density!(ax, bcx)
    ax = Axis(f[1,2]; xlabel="theoretical quantiles", ylabel="observed values")
    qqnorm!(ax, bcx; qqline=:fitrobust)
    colsize!(f.layout, 1, Aspect(1, 1.0))
    colsize!(f.layout, 2, Aspect(1, 1.0))
    resize_to_layout!(f)
    f
end
Example block output

We can also generate a diagnostic plot to see how well other parameter values would have worked for normalizing the data.

boxcoxplot(bc)
Example block output

The vertical line corresponds to the final parameter estimate.

If we specify a confidence level, then an additional horizontal line is added, which crosses the likelihood profile at the points corresponding to the edge of the confidence interval.

boxcoxplot(bc; conf_level=0.95)
Example block output

Box-Cox transformations of a conditional distribution

We can also consider transformations of a conditional distribution. As an example, we consider the trees dataset:

using BoxCox
using CairoMakie
using RDatasets: dataset as rdataset
using StatsModels

CairoMakie.activate!(; type="svg")

trees = rdataset("datasets", "trees")
first(trees, 5)
5×3 DataFrame
RowGirthHeightVolume
Float64Int64Float64
18.37010.3
28.66510.3
38.86310.2
410.57216.4
510.78118.8

For the conditional distribution, we want to fit a linear regression to the transformed response values and then evaluate the profile likelihood of the transformation. If the StatsModels package has been loaded, either directly or indirectly (e.g. via loading GLM.jl or MixedModels.jl), then a formula interface is available. (Otherwise, the model matrix and the response have to specified separately.)

bc = fit(BoxCoxTransformation, @formula(Volume ~ log(Height) + log(Girth)), trees)
Box-Cox transformation

estimated λ: -0.0673
resultant transformation:

 y^-0.1 - 1
------------
    -0.1

We can do all the same diagnostics as previously:

let f = Figure()
    ax = Axis(f[1, 1]; title="Raw")
    density!(ax, trees.Volume)
    ax = Axis(f[1, 2]; title="Transformed")
    density!(ax, bc.(trees.Volume))
    colsize!(f.layout, 1, Aspect(1, 1.0))
    colsize!(f.layout, 2, Aspect(1, 1.0))
    resize_to_layout!(f)
    f
end
Example block output
let f = Figure()
    ax = Axis(f[1, 1]; title="Raw", aspect=1)
    qqnorm!(ax, trees.Volume; qqline=:fitrobust)
    ax = Axis(f[1, 2]; title="Transformed", aspect=1)
    qqnorm!(ax, bc.(trees.Volume); qqline=:fitrobust)
    colsize!(f.layout, 1, Aspect(1, 1.0))
    colsize!(f.layout, 2, Aspect(1, 1.0))
    resize_to_layout!(f)
    f
end
Example block output
boxcoxplot(bc; conf_level=0.95)
Example block output

This last diagnostic plot suggests that λ = 0 is within the possible range of parameter values to consider. λ = 0 corresponds to a logarithmic transformation; given that the other variables are log-transformed, this suggests that we should consider using a log transform for the response.