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/.
First install it:
# install.packages("devtools")
devtools::install_github("bcgov/shinywqbench")
library(shinywqbench)
run_wqbench_app()
First, ensure the wqbench package
has been updated. This can be done by following the Developer
Instructions.
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.
Before deploying the app, run it locally to ensure that the changes to wqbench, and the internal dataset in the app, are functional:
library(shinywqbench)
run_wqbench_app()
If it looks good, stop the locally-running app, then:
- Go to the scripts/deploy.R file.
- 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.
To report issues, bugs or enhancements, please file an issue. Check out the support for more info.
Please note that the shinywqbench project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
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.