R/rcaaqs.R

# Copyright 2015 Province of British Columbia
# 
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
# 
# http://www.apache.org/licenses/LICENSE-2.0
# 
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.

#' rcaaqs: Tools for calculating CAAQS with air quality data
#' 
#' The rcaaqs package provides functions for the calculation of Canadian Ambient
#' Air Quality Standards (CAAQS).
#' 
#' @section rcaaqs functions:
#'   
#'   \itemize{ 
#'   \item General functions for doing things like formatting dates,
#'     filling in sequences, etc.
#'   \item Functions for step-wise calculation of CAAQS metrics for different 
#'     pollutants. Currently these are complete for fine particulate matter (PM2.5),
#'     ground-level ozone (O3), sulphur dioxide (SO2) and nitrogen dioxide (NO2).
#'   \item Functions for assigning metrics for different pollutants into 
#'     achievement and management categories.
#'   }
#'   
#' @import ggplot2
#' @importFrom rlang :=
#' @importFrom rlang .data
#' 
#' @docType package
#' @name rcaaqs
NULL
bcgov/rcaaqs documentation built on Dec. 12, 2023, 9:21 a.m.