CAQI_PM: Calcualte particulate matter sub-index of the European Common...
In unDocUMeantIt/paRticulates: Import and visualize fine dust sensor data

Description Usage Arguments Details Value Colors References See Also Examples

View source: R/CAQI_PM.R

The function returns the respective hourly CAQI grading, as defined by the Common Information to European Air (CITEAIR and CITEAIR II) projects[1].

1	CAQI_PM(x, norm = "PM10", raw = FALSE, latex_cellcolors = TRUE)

`x`	A numeric vector of particulate matter measurements (µg/m³).
`norm`	One value of either "PM10" or "PM2.5", setting the PM size of the given values of `x`.
`raw`	Logical, if true returns only the CAQI raw values.
`latex_cellcolors`	Logical, if true the "CAQI_color_*" columns will show LaTeX `\cellcolor` code instead of HTML colors. See `Colors` section.

The index has five levels, named "very low" (best air quality), "low", "medium", "high", and "very high" (worst air quality). Thresholds are different between PM10 and PM2.5 particles.

If raw=TRUE, a numeric vector with the raw CAQI values. Otherwise a data frame with four columns: raw input data, CAQI value, CAQI level (factor), recommended color code (factor). The column names start with "raw_", "CAQI_", "CAQI_level_", and "CAQI_color_", and end with either "PM10" or "PM2_5", depending on the value of norm.

The data frame contains rows to support coloring tables or plots, e.g. if you use the data in an RMarkdown document. If latex_cellcolors=FALSE, they provide a <span> with hexadecimal HTML color codes for each index value. Otherwise, the factor labels are in LaTeX format using the \cellcolor command. This is useful, e.g., if combined with the kableExtra::kable function. To use the code out of the box, define the following colors in your preamble (example shows usage in a YAML header):

header-includes:
   - \definecolor{CAQIvh}{HTML}{960018}
   - \definecolor{CAQIh}{HTML}{F29305}
   - \definecolor{CAQIm}{HTML}{EEC20B}
   - \definecolor{CAQIl}{HTML}{BBCF4C}
   - \definecolor{CAQIvl}{HTML}{79BC6A}