From 27a7a0558496b09a1e73f7c45cd8454b00a84005 Mon Sep 17 00:00:00 2001 From: Joao P Dubas Date: Thu, 3 Oct 2024 22:14:56 +0000 Subject: [PATCH] fix(growth): improve doc for centile calculation This module converts a given z-score and Box-Cox values into the related measurement. --- lib/growth/calc/centile.ex | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/lib/growth/calc/centile.ex b/lib/growth/calc/centile.ex index d06342f..5ae7ea2 100644 --- a/lib/growth/calc/centile.ex +++ b/lib/growth/calc/centile.ex @@ -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: