Skip to content

Latest commit

 

History

History
90 lines (72 loc) · 3.43 KB

README.md

File metadata and controls

90 lines (72 loc) · 3.43 KB

gnr: R Companion to the Global Nutrition Report

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. Lifecycle: experimental R-CMD-check Codecov test coverage CodeFactor DOI

The Global Nutrition Report’s purpose is to produce a single, authoritative source on progress toward addressing critical gaps in the nutrition accountability framework, both at national and international levels. This is a companion package to the Global Nutrition Report primarily for accessing the data used in the report and to reproduce the data visualisation produced in the report. This package contains functions that allow users to interrogate the same data and produce customised charts and other visualisation products.

What does gnr do?

Installation

The {gnr} package is not yet available on CRAN but can be installed from the nutriverse R Universe as follows:

install.packages(
  "gnr", 
  repos = c("https://nutriverse.r-universe.dev", "https://cloud.r-project.org")
)

The current development version of {gnr} can also be installed from GitHub using the {pak} package as follows:

if (!require("pak")) install.packages("pak")
pak::pak("nutriverse/gnr")

Usage

Citation

If you use {gnr} in your work, please cite using the suggested citation provided by a call to the citation function as follows:

citation("gnr")
#> To cite gnr in publications use:
#> 
#>   Ernest Guevarra (2025). _gnr: R companion to the Global Nutrition
#>   Report_. doi:10.5281/zenodo.187449399
#>   <https://doi.org/10.5281/zenodo.187449399>, R package version
#>   0.0.0.9000, <https://nutriverse.io/gnr/>.
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Manual{,
#>     title = {gnr: R companion to the Global Nutrition Report},
#>     author = {{Ernest Guevarra}},
#>     year = {2025},
#>     note = {R package version 0.0.0.9000},
#>     url = {https://nutriverse.io/gnr/},
#>     doi = {10.5281/zenodo.187449399},
#>   }

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.