docs: get consistent with how we describe the Extended IG-21st Newbor…

…n Size standards
ropensci · Nov 29, 2024 · f860175 · f860175
1 parent 2ba7ac1
commit f860175
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 11 deletions.
diff --git a/R/data.R b/R/data.R
@@ -60,7 +60,7 @@ NULL
 #' @keywords data
 NULL
 
-#' INTERGROWTH-21<sup>st</sup> Extended Newborn Size Standards (including very
+#' Extended INTERGROWTH-21<sup>st</sup> Newborn Size Standards (including very
 #' preterm) growth curve data
 #'
 #' @name ig_nbs_ext
@@ -79,7 +79,7 @@ NULL
 #' @keywords data
 NULL
 
-#' INTERGROWTH-21<sup>st</sup> Extended Newborn Size Standards GAMLSS
+#' Extended INTERGROWTH-21<sup>st</sup> Newborn Size Standards GAMLSS
 #' coefficients
 #'
 #' @name ig_nbs_ext_coeffs

diff --git a/README.Rmd b/README.Rmd
@@ -58,10 +58,11 @@ measures of fetal/newborn/child growth, which can then be used in downstream
 analyses.
 
 ## Installation
+
+You can install the development version of **gigs** from GitHub with `pak`:
 ```{r installation, eval = FALSE}
-# You can install the development version from GitHub with `remotes`:
-# install.packages("remotes")
-remotes::install_github(repo = "lshtm-gigs/gigs")
+# install.packages("pak")
+pak::pkg_install(pkg = "lshtm-gigs/gigs")
 ```
 
 ## Rationale + terminology
@@ -188,7 +189,7 @@ project:
   | `fmfga`  | fat mass-for-GA               | kg    | 266 to 294 days |
 
   </details>
-* `ig_nbs_ext` - `r intergrowth21st` Extended Newborn Size standards (including
+* `ig_nbs_ext` - Extended `r intergrowth21st` Newborn Size standards (including
   very preterm)
   <details><summary>Component standards</summary>
 
@@ -471,7 +472,7 @@ Excel-based calculators in some standards.
 **S. R. Parker** Maternal, Adolescent, Reproductive, and Child Health
 Centre, London School of Hygiene & Tropical Medicine
 
-**Dr L. Vesel** Ariadne Labs, Brigham and Women’s Hospital Harvard T.H.
+**Dr L. Vesel** Ariadne Labs, Brigham and Women’s Hospital, Harvard T.H.
 Chan School of Public Health
 
 **Professor E. O. Ohuma** Maternal, Adolescent, Reproductive, and Child

diff --git a/README.md b/README.md
@@ -229,7 +229,7 @@ and INTERGROWTH-21<sup>st</sup> project:
   | `fmfga`  | fat mass-for-GA               | kg    | 266 to 294 days |
 
   </details>
-- `ig_nbs_ext` - INTERGROWTH-21<sup>st</sup> Extended Newborn Size
+- `ig_nbs_ext` - Extended INTERGROWTH-21<sup>st</sup> Newborn Size
   standards (including very preterm)
   <details>
   <summary>

diff --git a/data-raw/r2sas.R b/data-raw/r2sas.R
@@ -128,7 +128,7 @@ ig_png_centiles <- ig_png_centiles |>
 
 gigs::gigs_input_options_set(new_value = "quiet")
 
-# IG-21st Extended NBS coeffs -----------------------------------------------------------
+# Extended IG-21st NBS coeffs -----------------------------------------------------------
 
 n_sex <- nrow(gigs::ig_nbs_ext_coeffs$wfga$male)
 dplyr::bind_rows(

diff --git a/man/ig_nbs_ext.Rd b/man/ig_nbs_ext.Rd
diff --git a/man/ig_nbs_ext_coeffs.Rd b/man/ig_nbs_ext_coeffs.Rd
diff --git a/vignettes/articles/benchmarking.Rmd b/vignettes/articles/benchmarking.Rmd
@@ -554,6 +554,7 @@ bp_ig_nbs_r <- bench::press(
   dplyr::mutate(desc = attr(expression, which = "description")) |>
   dplyr::select(input_len, median, desc)
 ```
+
 ### Stata
 ```{r, eval = FALSE}
 # Save .dta file equivalent of benchmarking table. This can be used to benchmark