joao.dubas/ex_trainer
1
0
Fork 0
Code Issues 1 Pull Requests 2 Projects Releases Wiki Activity

fix(growth): improve doc for centile calculation

Browse Source 
This module converts a given z-score and Box-Cox values into the related
measurement.
This commit is contained in:
João Paulo Dubas 2024-10-03 22:14:56 +00:00
parent fc0d9db7a5
commit 27a7a05584
Signed by: joao.dubas
SSH Key Fingerprint: SHA256:V1mixgOGRc/YMhGx/DNkOSmJxgA2vHNrDZEk3wt/kOA
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
lib/growth/calc/centile.ex
View File

@ -25,10 +25,9 @@ defmodule Growth.Calc.Centile do
@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`).
Compute the measurement value for a given z-score 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.`
Returns the measurement based on the z-score when -3 <= z-score <= 3; otherwise, `:na.`
## Examples: