- R 100%
|
|
||
|---|---|---|
| .github | update pkgdown tools links | |
| data | re-organise package; fix #1 | |
| data-raw | re-organise package; fix #1 | |
| inst | refresh repository | |
| man | address CRAN feedback | |
| pkgdown | update pkgdown tools links | |
| R | address CRAN feedback | |
| tests | refactor tests; fix #43 ; fix #44 ; fix #45 | |
| vignettes | address CRAN feedback | |
| .gitignore | update _pkgdown.yml; fix #47 ; fix #48 | |
| .Rbuildignore | refresh repository | |
| CITATION.cff | refresh repository | |
| codecov.yml | refresh repository | |
| cran-comments.md | address CRAN feedback | |
| DESCRIPTION | refresh repository | |
| LICENSE.md | initial commit | |
| micronutr.Rproj | re-organise package; fix #1 | |
| NAMESPACE | re-organise package; fix #1 | |
| NEWS.md | refresh repository | |
| README.md | refresh repository | |
| README.Rmd | refresh repository | |
micronutr: Determining Vitamin and Mineral Status of Populations
Project Status: Active – The project has reached a stable, usable state and is being actively developed. Lifecycle: stable CRAN status cran checks CRAN CRAN CRAN R-CMD-check test-coverage Codecov test coverage CodeFactor DOI
Vitamin and mineral deficiencies continue to be a significant public health problem. This is particularly critical in developing countries where deficiencies to vitamin A, iron, iodine, and other micronutrients lead to adverse health consequences. Cross-sectional surveys are helpful in answering questions related to the magnitude and distribution of deficiencies of selected vitamins and minerals.
This package provides tools for determining select vitamin and mineral deficiencies based on World Health Organization (WHO) guidelines found here.
About the package
The {micronutr} package provides tools for determining select vitamin
and mineral deficiencies using R. Currently, {micronutr} has functions
for:
-
Detecting haemoglobinaemia or anaemia based on an individual’s serum haemoglobin level;
-
Detecting inflammation status based on c-reactive protein (CRP) and alpha(1)-acid-glycoprotein (AGP);
-
Detecting iron deficiency status based on an individual’s serum ferritin level;
-
Detecting iodine deficiency status based on a population’s mean urinary iodine concentration.
Installation
You can install {micronutr} from CRAN
with:
install.packages("micronutr")
You can install the development version of {micronutr} from GitHub
using the {pak} package with:
if (!require("pak")) install.packages("pak")
pak::pak("nutriverse/pak")
You can also install {micronutr} from the nutriverse R
Universe with:
install.packages(
"micronutr",
repos = c('https://nutriverse.r-universe.dev', 'https://cloud.r-project.org')
)
Usage
{micronutr} comes packaged with vignettes that show how to use the
package for the purposes described above.
Citation
If you use {micronutr} in your work, please cite using the suggested
citation provided by a call to the citation function as follows:
citation("micronutr")
#> To cite micronutr in publications use:
#>
#> Ernest Guevarra, Nicholus Tint Zaw (2024). _micronutr: Determining
#> Vitamin and Mineral Status of Populations_.
#> doi:10.5281/zenodo.7503846 <https://doi.org/10.5281/zenodo.7503846>,
#> R package version 0.1.1, <https://nutriverse.io/micronutr/>.
#>
#> A BibTeX entry for LaTeX users is
#>
#> @Manual{,
#> title = {micronutr: Determining Vitamin and Mineral Status of Populations},
#> author = {{Ernest Guevarra} and {Nicholus Tint Zaw}},
#> year = {2024},
#> note = {R package version 0.1.1},
#> url = {https://nutriverse.io/micronutr/},
#> doi = {10.5281/zenodo.7503846},
#> }
Community guidelines
Feedback, bug reports, and feature requests are welcome; file issues or seek support here. If you would like to contribute to the package, please see our contributing guidelines.
This project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
References
-
Guideline on haemoglobin cutoffs to define anaemia in individuals and populations. Geneva: World Health Organization; 2024. Licence: CC BY-NC-SA 3.0 IGO.
-
Serum ferritin concentrations for the assessment of iron status in individuals and populations: technical brief. Geneva: World Health Organization; 2020. License: CC BY-NC-SA 3.0 IGO.
-
C-reactive protein concentrations as a marker of inflammation or infection for interpreting biomarkers of micronutrient status. Vitamin and Mineral Nutrition Information System. Geneva: World Health Organization; 2014.
-
Urinary iodine concentrations for determining iodine status deficiency in populations. Vitamin and Mineral Nutrition Information System. Geneva: World Health Organization; 2013.