From 15fa1c1e9756fd55e471dd35dad0a727a481c5b5 Mon Sep 17 00:00:00 2001 From: Simon Parker <65285181+awadafuk@users.noreply.github.com> Date: Sat, 9 Nov 2024 11:17:00 +0000 Subject: [PATCH] chore: Add some extra context to README.md --- README.Rmd | 30 +++++++++++++++++++++--------- README.md | 38 +++++++++++++++++++++++++------------- 2 files changed, 46 insertions(+), 22 deletions(-) diff --git a/README.Rmd b/README.Rmd index 33dde9d..3a99096 100644 --- a/README.Rmd +++ b/README.Rmd @@ -63,14 +63,26 @@ analyses. remotes::install_github(repo = "lshtm-gigs/gigs") ``` -## Terminology +## Rationale + terminology ```{r srr-tags-2, eval = FALSE, echo = FALSE} #' @srrstats {G1.3} Explained z-scores and centiles prior to discussing #' functions which convert between these and measured values. ``` -GIGS operates on anthropometric measurements, and can convert between these and -*z-scores*/*centiles*. Z-scores and centiles represent the location of a -measurement within a normal distribution of values, such that: +When working with growth measurements from individual children, it is helpful to +compare those measurements to a growth standard, which represents average growth +for an population of children. This allows assessment of individual growth - for +example, that a baby was born small, but later caught up to its peers in size. +It also allows you to compare measurements from different children. + +These standards of growth can be made in different ways, but the best studies +utilise international samples made of up thousands of healthy fetuses, newborns, +or children. In **gigs**, you'll find different international growth standards, +allowing you to compare growth measures from children with different ages, +weights, heights, and more. + +In general, you'll use **gigs** to transform raw growth measures to *z-scores* +or *centiles*. Z-scores and centiles represent the location of a measurement +within a normal distribution of values, such that: * A *z-score* is the number of standard deviations from the mean for a given anthropometric measurement (e.g. height or weight). @@ -81,11 +93,11 @@ measurement within a normal distribution of values, such that: corresponds to the 75th centile. In growth data, z-scores and centiles represent the size a fetus, newborn, or -child relative to its peers. Its size is considered relative to some -standardising variable, which is usually age but could also be another variable -such as their length. By tracking a child's relative size as they -grow, you can see if they are achieving their growth potential or not. If not, -this may indicate underlying issues such as ill health or undernutrition. +child relative to its peers. Size here is considered relative to a standardising +variable, which is usually age but could also be another variable such as their +length. By tracking a child's relative size as they grow, you can see if they +are achieving their growth potential or not. If not, this may indicate +underlying issues such as ill health or undernutrition. ## Classification functions GIGS includes a number of functions which permit fast identification of at-risk diff --git a/README.md b/README.md index 0e5b35b..2ee1aab 100644 --- a/README.md +++ b/README.md @@ -46,12 +46,24 @@ used in downstream analyses. remotes::install_github(repo = "lshtm-gigs/gigs") ``` -## Terminology +## Rationale + terminology -GIGS operates on anthropometric measurements, and can convert between -these and *z-scores*/*centiles*. Z-scores and centiles represent the -location of a measurement within a normal distribution of values, such -that: +When working with growth measurements from individual children, it is +helpful to compare those measurements to a growth standard, which +represents average growth for an population of children. This allows +assessment of individual growth - for example, that a baby was born +small, but later caught up to its peers in size. It also allows you to +compare measurements from different children. + +These standards of growth can be made in different ways, but the best +studies utilise international samples made of up thousands of healthy +fetuses, newborns, or children. In **gigs**, you’ll find different +international growth standards, allowing you to compare growth measures +from children with different ages, weights, heights, and more. + +In general, you’ll use **gigs** to transform raw growth measures to +*z-scores* or *centiles*. Z-scores and centiles represent the location +of a measurement within a normal distribution of values, such that: - A *z-score* is the number of standard deviations from the mean for a given anthropometric measurement (e.g. height or weight). @@ -63,12 +75,12 @@ that: centile. In growth data, z-scores and centiles represent the size a fetus, -newborn, or child relative to its peers. Its size is considered relative -to some standardising variable, which is usually age but could also be -another variable such as their length. By tracking a child’s relative -size as they grow, you can see if they are achieving their growth -potential or not. If not, this may indicate underlying issues such as -ill health or undernutrition. +newborn, or child relative to its peers. Size here is considered +relative to a standardising variable, which is usually age but could +also be another variable such as their length. By tracking a child’s +relative size as they grow, you can see if they are achieving their +growth potential or not. If not, this may indicate underlying issues +such as ill health or undernutrition. ## Classification functions @@ -466,8 +478,8 @@ Health Centre, London School of Hygiene & Tropical Medicine ### Citation -Parker SR, Vesel L, Ohuma EO (2023). *gigs: Assess Fetal, Newborn, and Child Growth with International Standards*. -. +Parker S, Vesel L, Ohuma EO (2024). *gigs: Assess Fetal, Newborn, and +Child Growth*. . ## Code of Conduct