nutrientsTimeTrend: Visualize time trends of nutrient intake levels

View source: R/Visualization_functions.R

nutrientsTimeTrendR Documentation

Visualize time trends of nutrient intake levels

Description

This function allows visualizing time trends of intake levels of one or several nutrients.

Usage

nutrientsTimeTrend(my_daily_food, food_database = "USDA", nutrients = NULL,
                   age = 27, gender = "female", pregnant = FALSE, lactation = FALSE)

Arguments

my_daily_food

matrix or list of matrices, where each matrix reports a daily intake. The matrix must have two columns: 1)"food" (reporting food names) and 2) "units" (reporting the number of units relative to 100 grams, e.g. 125 g -> 1.25).

food_database

character vector indicating the food database to be used. Possible values are: "USDA", "CIQUAL", "BEDCA", "STFCJ".

nutrients

character vector indicating the subset of nutrients that will be displayed. NULL indicates that all nutrients will be displayed.

age

numeric vector indicating age.

gender

character vector indicating gender (i.e. "female" or "male").

pregnant

logical constant indicating pregnancy status.

lactation

logical constant indicating lactation status.

Value

A timeseries plot displaying nutrient intake levels against time.

Examples

## Load data
data(food_composition_data)
data(NIH_nutrient_recommendations)
data(nutrient_group)
data(sample_diet_USDA) ## contains an example of a one-week diet

## Generate plots
nutrientsTimeTrend(my_daily_food = sample_diet_USDA, food_database = "USDA",
                   age = 27, gender = "female")

nutrientsTimeTrend(my_daily_food = sample_diet_USDA, food_database = "USDA",
                   nutrients = c("Calcium, Ca (mg)", "Iron, Fe (mg)"), age = 27,
                   gender = "female")

NutrienTrackeR documentation built on July 26, 2023, 5:22 p.m.