custom_exposure: Pull exposure series from data set

Description Usage Arguments Value Examples

View source: R/customizable_functions.R

Description

Example of a custom exposure function that can be passed to eesim or power_calc. By default, this function pulls exposure data from the Chicago NMMAPS data set in the dlnm package. The user may specify a different data set from which to pull exposure values.

Usage

1
2
custom_exposure(n, df = dlnm::chicagoNMMAPS, metric = "temp",
  start.date = NULL)

Arguments

n

A numeric value specifying the number of days for which to obtain an exposure value.

df

Data frame from which to pull exposure values.

metric

A character string specifying the desired exposure metric. Options are:

  • "temp"

  • "dptp"

  • "rhum"

  • "pm10"

  • "o3"

(Note: These are the column names for exposure measurements in the observed data.)

start.date

A date of the format "yyyy-mm-dd" from which to begin pulling exposure values. Dates in the Chicago NMMAPS data set are from 1987-01-01 to 2000-12-31.

Value

A numeric vector of length n giving exposure values.

Examples

1
custom_exposure(n = 5, metric = "temp", start.date = "2000-01-01")

eesim documentation built on June 4, 2017, 1:03 a.m.