README.md

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

wqindex

Overview

The wqindex R package calculates the CCME Water Quality Index and plots water quality indices spatially and temporally for British Columbia.

This functions in this package were originally written as a part of the wqbc package for the B.C. Ministry of Environment by Poisson Consulting. Ministry of Environment staff maintain the package. The original wqbc package is currently being split into two smaller pacakge. wqbc will be for cleaning, processing, and calculating limits/thresholds for water qualtity data, while this package will be for calculating the CCME Water Quality Index.

Install

# install.packages("remotes") # if remotes is not installed
remotes::install_github("bcgov/wqindex")
library(wqindex)

Project Status

This package is under active development and is not ready for use.

Getting Help or Reporting an Issue

To report bugs/issues/feature requests, please file an issue.

How to Contribute

If you would like to contribute to the package, please see our CONTRIBUTING guidelines.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

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.

This repository is maintained by Environmental Reporting BC. Click here for a complete list of our repositories on GitHub.

bcgov/wqindex documentation built on Feb. 17, 2024, 9:23 a.m.