R/package.R

In bcgov/wqindex: Water Quality Index Calculation for British Columbia

# 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.

#' Water Quality Index Calculation
#'
#' The wqindex package calculates water quality thresholds and indices for
#' freshwater life in British Columbia. To the best of the
#' package creator's knowledge the limits correspond to the
#' approved Provincial thresholds on the date of
#' release but wqbc comes with ABSOLUTELY NO WARRANTY. For further
#' information on the use of the wqbc package please type
#' \code{vignette("wqindex")} at the R console.
#'
#' @docType package
#' @name wqindex
#' @import assertthat
#' @importFrom magrittr %<>% %>%
#' @examples
#' \dontrun{
#'  demo(ccme)
#'  demo(dummy)
#'  demo(fraser)
#' }
#' @seealso \code{\link{calc_wqi}}
#' and \code{\link{plot_wqis}}
NULL