Skip to content

Commit

Permalink
Merge pull request #14 from nutriverse/dev
Browse files Browse the repository at this point in the history
replace microgram symbol
  • Loading branch information
ernestguevarra authored Feb 22, 2024
2 parents 9000b4e + 2c2cf16 commit 3c75f08
Show file tree
Hide file tree
Showing 11 changed files with 24 additions and 24 deletions.
4 changes: 2 additions & 2 deletions R/03-detect_inflammation.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions R/04-correct_ferritin.R
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
2 changes: 1 addition & 1 deletion R/05-detect_iron_deficiency.R
Original file line number Diff line number Diff line change
Expand Up @@ -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".
Expand Down
2 changes: 1 addition & 1 deletion R/06-detect_iodine_deficiency.R
Original file line number Diff line number Diff line change
Expand Up @@ -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**)
Expand Down
2 changes: 1 addition & 1 deletion R/data.R
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
8 changes: 4 additions & 4 deletions man/correct_ferritin.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/detect_inflammation.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/detect_iodine.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/detect_iron_deficiency.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/mnData.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions vignettes/iron-deficiency.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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)
Expand Down

0 comments on commit 3c75f08

Please sign in to comment.