above_ul: Calculate percent of population at risk of adverse effects

View source: R/above_ul.R

above_ulR Documentation

Calculate percent of population at risk of adverse effects

Description

This function calculates the percent of a population whose habitual intake is above the Tolerable Upper Limit (UL) and are therefore at risk of adverse effects.

Usage

above_ul(ul, shape = NULL, rate = NULL, meanlog = NULL, sdlog = NULL, plot = F)

Arguments

ul

Tolerable Upper Limit (UL)

shape

Shape parameter for gamma distribution

rate

Rate parameter for gamma distribution

meanlog

Mean parameter for gamma distribution

sdlog

Standard deviation parameter for gamma distribution

plot

Boolean (TRUE/FALSE) indicating whether to plot the distributions relative to the EAR

Value

The percent of a population at risk of adverse effects

Examples

above_ul(ul=11, shape=9.5, rate=1.3, plot=T)
above_ul(ul=11, meanlog=1.9, sdlog=0.3, plot=T)
above_ul(ul=13, meanlog=1.9, sdlog=0.3, plot=T)

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