wqbc

An R package for water quality thresholds and index calculation for British Columbia

https://github.com/bcgov/wqbc

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (18.8%) to scientific vocabulary

Keywords

data-science env r r-package rstats

Keywords from Contributors

species-sensitivity-distribution ecotoxicology ssd water-quality-guideline bcdc citz soe
Last synced: 6 months ago · JSON representation

Repository

An R package for water quality thresholds and index calculation for British Columbia

Basic Info
Statistics
  • Stars: 23
  • Watchers: 5
  • Forks: 8
  • Open Issues: 17
  • Releases: 9
Topics
data-science env r r-package rstats
Created about 11 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct

README.Rmd

---
output: github_document
html_preview: true
---




```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "README-"
)
```
# wqbc


[![img](https://img.shields.io/badge/Lifecycle-Maturing-007EC6)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
[![R build status](https://github.com/bcgov/wqbc/workflows/R-CMD-check/badge.svg)](https://github.com/bcgov/wqbc/actions)
[![Codecov test coverage](https://codecov.io/gh/bcgov/wqbc/branch/master/graph/badge.svg)](https://codecov.io/gh/bcgov/wqbc?branch=master)


## Overview

The `wqbc` R package facilitates cleaning and tidying water quality data and calculating water quality thresholds for British Columbia.
Previously it also calculated the [CCME Water Quality Index](http://www.ccme.ca/en/resources/canadian_environmental_quality_guidelines/index.html) but that functionality has been moved to the [wqindex](https://github.com/bcgov/wqindex) package.

`wqbc` was written by B.C. Ministry of Environment and [Poisson Consulting](http://www.poissonconsulting.ca/) team members.

## Usage

For more information please see the [vignette](https://htmlpreview.github.com/?https://github.com/bcgov/wqbc/master/inst/doc/wqbc.html). 
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](https://github.com/bcgov/wqindex)).

## Install

To install and load the latest version of wqbc:

```{r, eval = FALSE}
# install.packages("remotes") # if remotes is not installed
remotes::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](https://github.com/bcgov/wqbc/issues/).

## How to Contribute

If you would like to contribute to the package, please see our 
[CONTRIBUTING](CONTRIBUTING.md) guidelines.

Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). 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](http://www2.gov.bc.ca/gov/content?id=FF80E0B985F245CEA62808414D78C41B).
Click [here](https://github.com/bcgov/EnvReportBC-RepoList) for a complete list of our repositories on GitHub.    

Owner

  • Name: bcgov
  • Login: bcgov
  • Kind: organization
  • Email: Developer.Experience@gov.bc.ca
  • Location: Canada

This is the home for code that is open

GitHub Events

Total
  • Issues event: 4
  • Watch event: 2
  • Delete event: 1
  • Issue comment event: 4
  • Push event: 2
  • Pull request event: 2
  • Create event: 2
Last Year
  • Issues event: 4
  • Watch event: 2
  • Delete event: 1
  • Issue comment event: 4
  • Push event: 2
  • Pull request event: 2
  • Create event: 2

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 722
  • Total Committers: 11
  • Avg Commits per committer: 65.636
  • Development Distribution Score (DDS): 0.438
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
joethorley j****e@p****a 406
Andy Teucher a****r@g****a 140
colinpmillar c****r@g****m 86
Wendy Wang w****1@g****m 55
Ayla Pearson a****a@p****a 12
Seb Dalgarno s****b@p****a 9
Heather Thompson h****n@g****a 4
Robyn Irvine r****n@p****a 3
repo-mountie[bot] 4****] 3
stephhazlitt s****t@g****a 3
KarHarker k****r@g****a 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 113
  • Total pull requests: 58
  • Average time to close issues: 3 months
  • Average time to close pull requests: 7 days
  • Total issue authors: 11
  • Total pull request authors: 7
  • Average comments per issue: 2.97
  • Average comments per pull request: 0.81
  • Merged pull requests: 54
  • Bot issues: 6
  • Bot pull requests: 2
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • joethorley (58)
  • ateucher (14)
  • HeatherGranger (13)
  • stephhazlitt (9)
  • wenwangcode (6)
  • repo-mountie[bot] (6)
  • sebdalgarno (3)
  • colinpmillar (2)
  • aylapear (2)
  • atillmanns (1)
  • KarHarker (1)
Pull Request Authors
  • joethorley (31)
  • ateucher (13)
  • sebdalgarno (8)
  • KarHarker (3)
  • colinpmillar (2)
  • repo-mountie[bot] (2)
  • aylapear (1)
Top Labels
Issue Labels
enhancement (14) bug (6) in progress (3) maintenace (1) lakes (1) documentation (1) help wanted (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 5
proxy.golang.org: github.com/bcgov/wqbc
  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 7.0%
Average: 8.2%
Dependent repos count: 9.3%
Last synced: about 1 year ago

Dependencies

DESCRIPTION cran
  • R >= 3.4 depends
  • NADA * imports
  • chk * imports
  • dplyr * imports
  • grDevices * imports
  • lifecycle * imports
  • lubridate * imports
  • magrittr * imports
  • mgcv * imports
  • plyr * imports
  • purrr * imports
  • rlang * imports
  • stats * imports
  • stringr * imports
  • tibble * imports
  • tidyr * imports
  • zyp * imports
  • Kendall * suggests
  • canwqdata * suggests
  • covr * suggests
  • ggplot2 * suggests
  • knitr * suggests
  • rems >= 0.5.1 suggests
  • rmarkdown * suggests
  • testthat * suggests
  • xtable * suggests
.github/workflows/R-CMD-check.yaml actions
  • 8398a7/action-slack v3.0.0 composite
  • actions/cache v1 composite
  • actions/checkout v2 composite
  • actions/upload-artifact master composite
  • r-lib/actions/setup-pandoc master composite
  • r-lib/actions/setup-r master composite
.github/workflows/coverage.yaml actions
  • actions/cache v1 composite
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc master composite
  • r-lib/actions/setup-r master composite
.github/workflows/pkgdown.yaml actions
  • 8398a7/action-slack v3.0.0 composite
  • actions/cache v1 composite
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc master composite
  • r-lib/actions/setup-r master composite