get_caaqs: Extract results from a caaqs analysis

In bcgov/rcaaqs: Tools to implement CAAQS analysis for air quality

Extract results from a caaqs analysis

Description

Extract results from a caaqs analysis

Usage

get_caaqs(x)

get_hourly(x)

get_daily(x)

get_yearly(x)

get_three_yr_rolling(x)

Arguments

x	An object of class "caaqs" (result of running a ⁠*_caaqs()⁠ function)

Value

Varies according to the function and the parameter being analyzed:

get_caaqs():

• caaqs results

get_hourly():

• so2_1yr, no2_1yr: Hourly values used for annual average

• pm2.5_24h, pm2.5_annual, o3, so2_3yr, no2_3yr: None

get_daily():

• pm2.5_24h, pm2.5_annual: Daily average

• o3, so2_3yr, no2_3yr: Daily maximum

• so2_1yr, no2_1yr: None

get_yearly():

• pm2.5_24h: Annual 98th percentile daily average

• pm2.5_annual: Annual average of daily averages

• o3: Annual 4th highest daily maximum

• so2_1yr, no2_1yr: Annual average of hourly values

• so2_3yr: Annual 99th percentile of daily maximums

• no2_3yr: Annual 98th percentile of daily maximums

get_three_yr_rolling()

• pm2.5_24h, pm2.5_annual, o3, so2_3yr, no2_3yr: Three-year rolling average of the yearly value.

• so2_1yr, no2_1yr: None

Examples

pm <- pm_24h_caaqs(pm25_sample_data, by = c("ems_id", "site"))

get_caaqs(pm)

# Extract intermediate objects:

get_daily(pm)
get_yearly(pm)
get_three_yr_rolling(pm)

bcgov/rcaaqs documentation built on Dec. 12, 2023, 9:21 a.m.