An R package for water quality thresholds and index calculation for British Columbia
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R
data-raw
data
demo
inst
man
tests
vignettes_ignore
.Rbuildignore
.gitattributes
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
DESCRIPTION
LICENSE
NAMESPACE
NEWS.md
README.Rmd
README.md
wqbc.Rproj

README.md

wqbc

Being designed and built, but in the lab. May change, disappear, or be buggy.Travis-CI Build Status

Overview

The wqbc R package helps clean and process water quality data and calculates water quality thresholds for British Columbia. Previously this package also calculated the CCME Water Quality Index but that functionality has been moved to its own package: wqindex.

This package was written for the B.C. Ministry of Environment by Poisson Consulting. Ministry of Environment staff maintain the package.

Usage

For information on use, please see the vignette. In your R session, you can type vignette("wqbc") to see the vignette. Please note that this vignette is currently out of date as it includes information on calculating the Water Quality Index (which has been moved to its own package wqindex).

Install

To install the latest version of wqbc:

# install the devtools package if it's not already installed
# install.packages("devtools")
library(devtools)
install_github("bcgov/wqbc")
library(wqbc)

Project Status

This package is under development. The user is responsible for checking all variables and limits that they 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.