-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.Rmd
89 lines (63 loc) · 3.01 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
89
---
output: github_document
---
# shinywqbench
<!-- badges: start -->
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
<!-- badges: end -->
This package is a shiny app that makes using the functions of the `wqbench` package accessible to non-R users.
The live app is available at: https://bcgov-env.shinyapps.io/shinywqbench/.
## How to install and launch app locally:
First install it:
```{r, eval=FALSE}
# install.packages("devtools")
devtools::install_github("bcgov/shinywqbench")
```
```{r, eval=FALSE}
library(shinywqbench)
run_wqbench_app()
```
## How to Update the Shiny App
First, ensure the [wqbench](https://github.com/bcgov/wqbench) package has been
updated. This can be done by following the
[Developer Instructions](https://bcgov.github.io/wqbench/articles/Developer-instructions.html).
Once this is completed, install the updated version of the wqbench package with
`devtools::install_github("bcgov/wqbench")`.
Then to pull these updates over to this repository (shinywqbench), run the
script in the `inst/extdata/data.R` file.
## How to Deploy the App to the web
Before deploying the app, run it locally to ensure that the changes to wqbench,
and the internal dataset in the app, are functional:
```{r, eval=FALSE}
library(shinywqbench)
run_wqbench_app()
```
If it looks good, stop the locally-running app, then:
1. Go to the *scripts/deploy.R* file.
2. Run the script.
It is advised to first run the code that deploys the app name of `shinywqbench-dev` and confirm the app deploys and functions as expected.
This app is referred to as the development app.
Once it has been confirmed that the app functions and deploys properly to then run the second chunk of code with the app name `shinywqbench`.
This app is referred to as the production app.
This will help to ensure the production app is always in a working state.
## Getting Help or Reporting an Issue
To report issues, bugs or enhancements, please file an [issue](https://github.com/bcgov/wqbench/issues).
Check out the [support](https://github.com/bcgov/wqbench/blob/main/.github/SUPPORT.md) for more info.
## Code of Conduct
Please note that the shinywqbench project is released with a [Contributor Code of Conduct](https://github.com/bcgov/shinywqbench/CODE_OF_CONDUCT.md).
By contributing to this project, you agree to abide by its terms.
## License
The code is released under the Apache License 2.0
> Copyright 2023 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
>
> https://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.