diff --git a/R/03-detect_inflammation.R b/R/03-detect_inflammation.R index 8f7f1a2..943087e 100644 --- a/R/03-detect_inflammation.R +++ b/R/03-detect_inflammation.R @@ -14,9 +14,9 @@ #' 359S–371S. https://doi.org/10.3945/ajcn.116.141762 #' #' @param crp A numeric value or numeric vector of c-reactive protein (crp) -#' values in micrograms per litre (µg/l). +#' values in micrograms per litre (microgram/l). #' @param agp A numeric value or numeric vector of alpha(1)-acid-glycoprotein -#' (agp) values in micrograms per litre (µg/l). +#' (agp) values in micrograms per litre (microgram/l). #' @param label Logical. Should labels be used to classify inflammation status? #' If TRUE (default), status is classified as "no inflammation" or #' "inflammation" based on either CRP or AGP or status is classified as diff --git a/R/04-correct_ferritin.R b/R/04-correct_ferritin.R index 95b6065..f6ad82e 100644 --- a/R/04-correct_ferritin.R +++ b/R/04-correct_ferritin.R @@ -13,14 +13,14 @@ #' https://doi.org/10.3945/ajcn.116.141762 #' #' @param crp A numeric value or numeric vector for serum c-reactive protein in -#' micrograms per litre (µg/l). +#' micrograms per litre (microgram/l). #' @param agp A numeric value or numeric vector for serum -#' alpha(1)-acid-glycoprotein in micrograms per litre (µg/l). +#' alpha(1)-acid-glycoprotein in micrograms per litre (microgram/l). #' @param ferritin A numeric value or numeric vector for serum ferritin in -#' micrograms per litre (µg/l). +#' micrograms per litre (microgram/l). #' #' @return A numeric value or numeric vector for corrected serum ferritin in -#' micrograms per litre (µg/l). +#' micrograms per litre (microgram/l). #' #' @examples #' correct_ferritin( diff --git a/R/05-detect_iron_deficiency.R b/R/05-detect_iron_deficiency.R index abe88da..6608890 100644 --- a/R/05-detect_iron_deficiency.R +++ b/R/05-detect_iron_deficiency.R @@ -6,7 +6,7 @@ #' Given serum ferritin values, determine iron storage status. #' #' @param ferritin A numeric value or numeric vector of serum ferritin level in -#' micrograms per litre (µg/L). +#' micrograms per litre (microgram/L). #' @param group A character value specifying the population target group to #' determine iron status from. Can be either for under 5 year old ("u5") or #' 5 years and over ("5over"). Default to "u5". diff --git a/R/06-detect_iodine_deficiency.R b/R/06-detect_iodine_deficiency.R index 3d9a4e5..c90a680 100644 --- a/R/06-detect_iodine_deficiency.R +++ b/R/06-detect_iodine_deficiency.R @@ -8,7 +8,7 @@ #' (**lactating**). #' #' @param iodine A numeric value or numeric vector of median urinary iodine -#' concentration (μg/L) of the population or populations of interest. +#' concentration (microgram/L) of the population or populations of interest. #' @param group The population group of interest. Either school age children #' (**general**), pregnant women (**pregnant**), or lactating women with #' children under 2 years old (**lactating**) diff --git a/R/data.R b/R/data.R index 620bbbb..b7f4960 100644 --- a/R/data.R +++ b/R/data.R @@ -16,7 +16,7 @@ #' *group* | Group classification #' *hb* | Haemoglobin values (g/L) #' *calcium* | Serum calcium values () -#' *crp* | Serum c-reactive protein (µg/l) +#' *crp* | Serum c-reactive protein (microgram/l) #' *ferritin* | Serum ferritin () #' *iodine* | Urine iodine () #' *altitude* | Altitude of sampling location above sea level (metres) diff --git a/man/correct_ferritin.Rd b/man/correct_ferritin.Rd index 1c0d372..cd29fe2 100644 --- a/man/correct_ferritin.Rd +++ b/man/correct_ferritin.Rd @@ -8,17 +8,17 @@ correct_ferritin(crp = NULL, agp = NULL, ferritin = NULL) } \arguments{ \item{crp}{A numeric value or numeric vector for serum c-reactive protein in -micrograms per litre (µg/l).} +micrograms per litre (microgram/l).} \item{agp}{A numeric value or numeric vector for serum -alpha(1)-acid-glycoprotein in micrograms per litre (µg/l).} +alpha(1)-acid-glycoprotein in micrograms per litre (microgram/l).} \item{ferritin}{A numeric value or numeric vector for serum ferritin in -micrograms per litre (µg/l).} +micrograms per litre (microgram/l).} } \value{ A numeric value or numeric vector for corrected serum ferritin in -micrograms per litre (µg/l). +micrograms per litre (microgram/l). } \description{ Based on inflammation status, correct serum ferritin values as described in diff --git a/man/detect_inflammation.Rd b/man/detect_inflammation.Rd index e5fb09e..dae5a9f 100644 --- a/man/detect_inflammation.Rd +++ b/man/detect_inflammation.Rd @@ -14,10 +14,10 @@ detect_inflammation_agp(agp = NULL, label = TRUE) } \arguments{ \item{crp}{A numeric value or numeric vector of c-reactive protein (crp) -values in micrograms per litre (µg/l).} +values in micrograms per litre (microgram/l).} \item{agp}{A numeric value or numeric vector of alpha(1)-acid-glycoprotein -(agp) values in micrograms per litre (µg/l).} +(agp) values in micrograms per litre (microgram/l).} \item{label}{Logical. Should labels be used to classify inflammation status? If TRUE (default), status is classified as "no inflammation" or diff --git a/man/detect_iodine.Rd b/man/detect_iodine.Rd index e665754..c85aea8 100644 --- a/man/detect_iodine.Rd +++ b/man/detect_iodine.Rd @@ -21,7 +21,7 @@ detect_iodine_lactating(iodine = NULL, label = TRUE) } \arguments{ \item{iodine}{A numeric value or numeric vector of median urinary iodine -concentration (μg/L) of the population or populations of interest.} +concentration (microgram/L) of the population or populations of interest.} \item{group}{The population group of interest. Either school age children (\strong{general}), pregnant women (\strong{pregnant}), or lactating women with diff --git a/man/detect_iron_deficiency.Rd b/man/detect_iron_deficiency.Rd index b266b94..02a1d31 100644 --- a/man/detect_iron_deficiency.Rd +++ b/man/detect_iron_deficiency.Rd @@ -22,7 +22,7 @@ detect_iron_deficiency_qualitative( } \arguments{ \item{ferritin}{A numeric value or numeric vector of serum ferritin level in -micrograms per litre (µg/L).} +micrograms per litre (microgram/L).} \item{label}{Logical. Should labels be used to classify iron storage status? If TRUE (default), status is classified as "no iron deficiency" or diff --git a/man/mnData.Rd b/man/mnData.Rd index e253cae..195e233 100644 --- a/man/mnData.Rd +++ b/man/mnData.Rd @@ -13,7 +13,7 @@ A tibble with 9 columns and 19449 rows.\tabular{ll}{ \emph{group} \tab Group classification \cr \emph{hb} \tab Haemoglobin values (g/L) \cr \emph{calcium} \tab Serum calcium values () \cr - \emph{crp} \tab Serum c-reactive protein (µg/l) \cr + \emph{crp} \tab Serum c-reactive protein (microgram/l) \cr \emph{ferritin} \tab Serum ferritin () \cr \emph{iodine} \tab Urine iodine () \cr \emph{altitude} \tab Altitude of sampling location above sea level (metres) \cr diff --git a/vignettes/iron-deficiency.Rmd b/vignettes/iron-deficiency.Rmd index 2041b42..c865d22 100644 --- a/vignettes/iron-deficiency.Rmd +++ b/vignettes/iron-deficiency.Rmd @@ -18,14 +18,14 @@ knitr::opts_chunk$set( library(micronutr) ``` -Given an individual's serum ferritin level (µg/L), iron deficiency status can be classified as either *present* or *not present*. The serum ferritin cut-offs for classification of iron deficiency status are different for specific population groups as shown in the table below. +Given an individual's serum ferritin level (microgram/L), iron deficiency status can be classified as either *present* or *not present*. The serum ferritin cut-offs for classification of iron deficiency status are different for specific population groups as shown in the table below. -**Population** | **Serum ferritin (µg/L) to classify as iron deficient** +**Population** | **Serum ferritin (microgram/L) to classify as iron deficient** :--- | :--- under 5 years of age | < 12 5 years and over | < 15 -The functions in the `detect_anaemia` function set use these serum ferritin cut-offs to classify individuals from specific population groups as either having **no iron deficiency** or having **iron deficiency**. For example, a three year old with a serum ferritin level of 11.3 µg/L can be classified as follows: +The functions in the `detect_anaemia` function set use these serum ferritin cut-offs to classify individuals from specific population groups as either having **no iron deficiency** or having **iron deficiency**. For example, a three year old with a serum ferritin level of 11.3 microgram/L can be classified as follows: ```{r ferritin1, echo = TRUE} detect_iron_deficiency_u5(ferritin = 11.3) @@ -63,7 +63,7 @@ Serum ferritin is affected by the inflammation and/or infection status of an ind It is recommended that serum ferritin be adjusted accordingly depending on the inflammation or infection status of an individual. There are three ways of correcting or adjusting for inflammation or infection status when assessing iron deficiency. -The first approach is by increasing the serum ferritin cut-off for detecting iron deficiency. The recommendation is that if an individual has been assessed to be in an inflammatory or infectious state, serum ferritin level of less than 30 µg/L will classify this individual as being iron deficient regardless of age group. +The first approach is by increasing the serum ferritin cut-off for detecting iron deficiency. The recommendation is that if an individual has been assessed to be in an inflammatory or infectious state, serum ferritin level of less than 30 microgram/L will classify this individual as being iron deficient regardless of age group. The function `detect_iron_deficiency_qualitative()` facilitates this classification. For example, a 2 year old with a serum ferritin of 15.6 microgram/L who has been assessed to have an active infection, we can assess iron deficiency status as follows: @@ -122,13 +122,13 @@ In some settings, values for both CRP and AGP may not be available. Usually, onl CRP | > 5 microgram/L | 0.65 AGP | > g/L | 0.72 -For example, for a person with serum ferritin of 11.3 µg/L and a CRP of 2, we use the `correct_ferritin()` function as follows: +For example, for a person with serum ferritin of 11.3 microgram/L and a CRP of 2, we use the `correct_ferritin()` function as follows: ```{r ferritin10, echo = TRUE} correct_ferritin(crp = 2, ferritin = 11.3) ``` -and for a person with serum ferritin of 11.3 µg/L and an AGP of 2, we use the `correct_ferritin()` function as follows: +and for a person with serum ferritin of 11.3 microgram/L and an AGP of 2, we use the `correct_ferritin()` function as follows: ```{r ferritin11, echo = TRUE} correct_ferritin(agp = 2, ferritin = 11.3)