-
Notifications
You must be signed in to change notification settings - Fork 4
/
README.Rmd
88 lines (63 loc) · 3.27 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# shinyrems
<!-- badges: start -->
[](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
[](https://opensource.org/licenses/Apache-2.0)
<!-- badges: end -->
`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
Copyright 2019 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.