search

bcgov / shinyssdtools

Shiny interface to ssdtools R package
https://bcgov.github.io/shinyssdtools/
Apache License 2.0
7 stars 4 forks source link
env species-sensitivity-distribution ssd water-quality-guideline

readme

shinyssdtools

Lifecycle: maturing R-CMD-check Apache license DOI

shinyssdtools is a Shiny application for fitting Species Sensitivity Distributions (SSDs) using ssdtools.

Utilization

The most recent version is available online at https://bcgov-env.shinyapps.io/ssdtools/.

To install the development version from GitHub and deploy locally use

# install.packages("devtools")
devtools::install_github("bcgov/shinyssdtools")
library(shinyssdtools)
shinyssdtools::run_app()

Features

In addition to being a Graphical User Interface to the core functionality in the ssdtools package, shinyssdtools also provides

Information

For more information including how to cite shinyssdtools see Dalgarno (2021).

For a review of ssdtools and shinysddtools in the context of other SSD software packages see Fox et al. (2021).

Assistance

To report bugs/issues/feature requests, please file an issue.

Contribution

If you would like to contribute, 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.

Deploying to shinyapps.io

Manually

Run the deploy-app.R script in the scripts directory (after setting the account argument to be your shinyapps.io account name).

Automatically

If your shinyapps.io account name is the same as your GitHub account name simply make a commit in the master or dev branch and include deploy app in the message (after setting SHINYAPPS_TOKEN and SHINYAPPS_SECRET in your repository GitHub secrets). This triggers the deploy-app.yml GitHub action.

License

The code is released under the Apache License 2.0

Copyright 2021 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.

<img alt="Creative Commons Licence" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/80x15.png" />
<span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">ssdtools by <span xmlns:cc="http://creativecommons.org/ns#" property="cc:attributionName">the Province of British Columbia is licensed under a Creative Commons Attribution 4.0 International License.