Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bcgov/shinyrems

An R package to launch shinyrems; an online application that allows a user to access, download, clean, plot and calculate simple statistics using data from the B.C. government Environmental Monitoring System database.
https://github.com/bcgov/shinyrems

data-analysis environment environmental-data water-quality

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/bcgov/shinyrems
Owner: bcgov
License: other
Created: 2019-03-14T23:25:14.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-11-27T22:18:23.000Z (12 months ago)
Last Synced: 2024-06-11T17:11:23.313Z (5 months ago)
Topics: data-analysis, environment, environmental-data, water-quality
Language: R
Homepage: https://bcgov.github.io/shinyrems/
Size: 117 MB
Stars: 18
Watchers: 10
Forks: 4
Open Issues: 6
Metadata Files:
- Readme: README.Rmd
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

jimsghstars - bcgov/shinyrems - An R package to launch shinyrems; an online application that allows a user to access, download, clean, plot and calculate simple statistics using data from the B.C. government Environmental Monitoring (R)

README

---
output: github_document
---

```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```

# shinyrems

[![img](https://img.shields.io/badge/Lifecycle-Maturing-007EC6)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
[![Apache license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

`shinyrems` is an app that allows you to download, clean, visualize and analyze data from the Environmental Monitoring System (EMS) database. Create plots and view water quality data with BC aquatic life water quality guidelines.

## Installation

To install the latest development version from [GitHub](https://github.com/bcgov/shinyrems)
``` r
# install.packages("remotes")
remotes::install_github("bcgov/rems")
remotes::install_github("bcgov/wqbc")
remotes::install_github("bcgov/shinyrems")
```

Please remember to restart your R session after installation.

## Usage
See the [User Guide](https://bcgov.github.io/shinyrems/articles/shinyrems.html) for a more detailed explanation of app usage.

ShinyRems app can be run with various EMS datasets that must be downloaded and stored on the user's computer. Prior to app startup, you will be prompted to download data if required and you will be notified if data updates are available.

There are six possible run modes corresponding to different
datasets:

- **'demo'** - uses a demo dataset that requires no download of EMS data
- **'2yr'** - uses most recent 2 years of EMS data
- **'4yr'** - uses most recent 4 years of EMS data
- **'historic'** - uses historic EMS data (1965 - (Current Year - 2 Years))
- **'all'** - uses combined "2yr" and "historic" EMS data
- **'upload'** - allows user to upload their own data following correct format

To select a run mode, provide the value (as it appears above) to `shinyrems::run_ems_app()`. For example, type the following into your R console:

```{r, eval = FALSE}
# select historic run mode
shinyrems::run_ems_app("historic")

# select upload run mode
shinyrems::run_ems_app("upload")

# "2yr" run mode is the default and will be selected if no other value is provided
shinyrems::run_ems_app()
```

## Contribution

Please report any [issues](https://github.com/bcgov/shinyrems/issues).

[Pull requests](https://github.com/bcgov/shinyrems/pulls) are always welcome.

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

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.