An R package to facilitate analysis and visualization of groundwater data from the British Columbia groundwater observation well network
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
R
inst/doc
man
tests
vignettes
.Rbuildignore
.gitattributes
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
DESCRIPTION
LICENSE
Makefile
NAMESPACE
NEWS.md
README.md
bcgroundwater.Rproj

README.md

bcgroundwater

In production, but maybe in Alpha or Beta. Intended to persist and be supported.Travis-CI Build StatusLicense

Overview

An R package to facilitate analysis and visualisation of groundwater data from the British Columbia Provincial Groundwater Observation Well Network.

The package provides functions for importing, cleaning, and summarising groundwater data, analysing long-term trends in groundwater levels, and visualising analysis results. The package was developed by Environmental Reporting BC to support our water indicator on long-term trends in groundwater levels. The code behind that analysis is available in its own GitHub repository.

Features

Core functions include:

  • Import data downloaded from the B.C. Data Catalogue distributed under the Open Government Licence-British Columbia
  • Summarise and plot monthly groundwater levels
  • Interpolate missing values
  • Perform Mann-Kendall trend tests with pre-whitening on multiple datasets using methods implemented in the zyp package
  • Plot trends in groundwater levels

Installation

You can install the package directly from this repository. To do so, you will need the remotes package:

install.packages("remotes")

Next, install the bcgroundwater package using remotes::install_github():

library("remotes")
install_github("bcgov/bcgroundwater")

Usage

See the package vignette for a simple demonstration. Or, after installing the package, use:

browseVignettes("bcgroundwater")

Project Status

The package works as is for the intended purpose, which was to provide a set of functions required for the analysis underlying the Environmental Reporting BC indicator. We are actively updating the package at this time, you can check the issues for things we are fixing or working on.

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.