airzone_metric: Calculate the airzone metric

View source: R/airzone_metric.R

airzone_metricR Documentation

Calculate the airzone metric

Description

Calculate the metrics for each airzone based on station-level results. Determines the CAAQS achievement levels and CAAQS management levels for each airzone and reports on the representative stations for these metrics in each airzone.

Usage

airzone_metric(
  data,
  n_years = "n_years",
  az = "airzone",
  station_id = "ems_id",
  ambient_metric_val = "metric_value_ambient",
  ambient_caaqs = "caaqs_ambient",
  excluded = "excluded",
  mgmt_metric_val = "metric_value_mgmt",
  mgmt = "mgmt_level",
  keep = NULL
)

Arguments

data

The dataframe

n_years

The column containing the number of years each 3yr avg is based on

az

The airzone column

station_id

The column containing the unique station id

ambient_metric_val

The column containing the ambient CAAQS metric for individual stations

ambient_caaqs

The column containing the CAAQS achievement levels for individual stations

excluded

Logical vector indicating if ambient data was excluded for calculating the CAAQS management levels

mgmt_metric_val

The column containing the management CAAQS metric for individual stations

mgmt

The column containing the CAAQS management levels for individual stations

keep

Character vector specifying the columns in the input data that you would like to retain in the output data frame.

Value

A dataframe with 9 columns: airzone, number of years in calculation, ambient CAAQS metric value, CAAQS achievement levels, ambient reporting station id, logical vector indicating if ambient data was excluded for management calculations, management CAAQS metric value, CAAQS management levels, and management reporting station id.


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