shinyssdtools

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

  • a bilingual (English/French) interface;
  • generation of R scripts for reproducibility;
  • customization and downloads of plots and tables
  • Generation of html/pdf report

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.

Consultation

Versioning

The ssdtools and shinyssdtools development team is using Semantic Versioning for numbering releases. For example, using the notation “v 2.3.0”, the first number is the major version, the second the minor version and the third the patch version – i.e. v MAJOR.MINOR.PATCH. Each of these number levels relates to the following types of updates:

  • MAJOR versions – updates that result in changes to the way that water quality guideline values are calculated (produced using ssd_fit_bcanz() and ssd_hc_bcanz() and the shinyssdtools application).
  • MINOR versions – updates that add new functionality (e.g. for researchers) but which do not change the way that water quality guideline values are calculated.
  • PATCH versions – updates that fix bugs.

Review Process

The jurisdictional consultation and review process for ssdtools updates is set out as follows:

  • MAJOR version releases
    • the ssdtools Technical Committee will review and approve/not approve proposed changes to ssdtools and shinyssdtools updates that would constitute MAJOR version releases.
    • The ssdtools Technical Committee will approve/not approve a MAJOR version release.
  • MINOR versions releases
    • the ssdtools Technical Committee will be consulted on and will provide guidance on MINOR version updates.
  • PATCH version releases
    • the ssdtools Technical Committee will not be consulted on PATCH version releases unless the ssdtools and shinyssdtools development team identify a need to do so.

License

The code is released under the Apache License 2.0

Copyright 2015-2025 Province of British Columbia, 2021 Environment and Climate Change Canada, 2023-2025 Australian Government Department of Climate Change, Energy, the Environment and Water

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.

Creative Commons Licence
ssdtools by the Province of British Columbia is licensed under a Creative Commons Attribution 4.0 International License.