ex_trainer/lib/growth/calc/centile.ex
Joao P Dubas 5c044e69d9
fix(growth): use centile and percentile correctly
1. The calculation made in `Grownth.Calc.Centile.compute/4` converts a
   given z-score into the expected measurement value.
   This can be used to get specific values for key z-scores, such as,
   -3, -2, 2 and 3.
2. To calculate the percentile of a given z-score the system uses the
   cumulative distribution function.
2024-08-28 13:03:45 +00:00

47 lines
1.4 KiB
Elixir

defmodule Growth.Calc.Centile do
@moduledoc """
Calculate the value of measurement at a given z-score and fitted values of Box-Cox by age/height:
* **power** `t:Growth.Calc.ZScore.l/0`
* **median** `t:Growth.Calc.ZScore.m/0`
* **coefficientof variation** `t:Growth.Calc.ZScore.s/0`
This calculation is described in the [instructions provided by the World Health Organization](https://cdn.who.int/media/docs/default-source/child-growth/growth-reference-5-19-years/computation.pdf).
## Examples:
iex> measures =
...> [
...> [-3.0, -1.7862, 16.9392, 0.1107],
...> [2, -1.3592, 20.4951, 0.12579],
...> [-1.2, -1.6318, 16.049, 0.10038]
...> ]
iex> Enum.map(measures, &apply(Growth.Calc.Centile, :compute, &1))
[:na, :na, 19.0]
"""
alias Growth.Calc.ZScore
@spec compute(number(), ZScore.l(), ZScore.m(), ZScore.s()) :: number() | :na
@doc """
Compute the centile for a given measurement (`y`) and the Box-Cox values: power (`l`), median (`m`), and
coefficient of variation (`s`).
Returns the centile based on the z-score when -3 <= z-score <= 3; otherwise, returns `:na.`
## Examples:
iex> Growth.Calc.Centile.compute(0.0, -1.6318, 16.049, 0.10038)
19.0
"""
def compute(z_score, l, m, s) when -3 <= z_score and z_score <= 3 do
m * :math.pow(1 + l * s * z_score, 1 / l)
end
def compute(_z_score, _l, _m, _s) do
:na
end
end