get_dists: Get subnational nutrient intake distributions

In cfree14/nutriR: Nutritional intake functions for R

Get subnational nutrient intake distributions

Description

This function retrieves the subnational nutrient intake distributions modelled by Passarreli et al. (in prep).

Usage

get_dists(nutrients = NULL, isos = NULL, sexes = NULL, ages = NULL)

Arguments

nutrients	A character vector of nutrients of interest (e.g., "Iron", "Calcium", etc.)
isos	A character vector of ISO3s of countries of interest (e.g., "USA")
sexes	A character string of sexes of interest (i.e., "M", "F", or "MF")
ages	A numeric vector of ages of interest (e.g., 10:50, 0:75, 55:90)

Value

A data frame with the parameters describing the requested subnational intake distributions

Examples

dists_all <- get_dists()
dists_usa <- get_dists(isos="USA")
dists_usa_iron <- get_dists(isos="USA", nutrients="Iron", sexes="MF")
dists_usa_iron_2040 <- get_dists(isos="USA", nutrients="Iron", sexes="MF", ages=20:40)

cfree14/nutriR documentation built on Oct. 31, 2024, 6:27 p.m.