A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

shinyssdtools

A Shiny application for fitting species sensitivity distribution, a method for getting water quality benchmarks to characterize effects of chemical contaminants for water quality or ecological risk assessment.
https://github.com/bcgov/shinyssdtools

Category: Biosphere
Sub Category: Species Distribution Modeling

Keywords

env species-sensitivity-distribution ssd water-quality-guideline

Keywords from Contributors

ecotoxicology fish kootenay-lake shiny

Last synced: 7 minutes ago
JSON representation

Repository metadata

Shiny interface to ssdtools R package

README.Rmd

          ---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# shinyssdtools


[![Lifecycle: maturing](https://img.shields.io/badge/Lifecycle-Maturing-007EC6)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
[![R-CMD-check](https://github.com/bcgov/shinyssdtools/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/bcgov/shinyssdtools/actions/workflows/R-CMD-check.yaml)
[![Apache license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![DOI](https://joss.theoj.org/papers/10.21105/joss.02848/status.svg)](https://doi.org/10.21105/joss.02848)


`shinyssdtools` is a Shiny application for fitting Species Sensitivity Distributions (SSDs) using [`ssdtools`](https://github.com/bcgov/ssdtools).

## Utilization

The most recent version is available online at .

To install the development version from [GitHub](https://github.com/bcgov/shinyssdtools) and deploy locally use

``` r
# 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`](https://github.com/bcgov/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)](https://doi.org/10.21105/joss.02848).

For a review of `ssdtools` and `shinysddtools` in the context of other SSD software packages see [Fox et al. (2021)](https://onlinelibrary.wiley.com/doi/10.1002/etc.4925).

## Assistance

To report bugs/issues/feature requests, please file an [issue](https://github.com/bcgov/shinyssdtools/issues/).

## Contribution

If you would like to contribute, please see our [CONTRIBUTING](CONTRIBUTING.md) guidelines.

Please note that this project is released with a [Contributor Code of Conduct](https://github.com/bcgov/shinyssdtools/blob/master/.github/CONTRIBUTING.md). 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.

-----

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

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 495
Total Committers: 10
Avg Commits per committer: 49.5
Development Distribution Score (DDS): 0.259

Commits in past year: 87
Committers in past year: 3
Avg Commits per committer in past year: 29.0
Development Distribution Score (DDS) in past year: 0.161

Name Email Commits
Seb Dalgarno s****b@p****a 367
Ayla Pearson a****3@g****m 68
Joe Thorley j****e@p****a 41
Angeline Tillmanns A****s@g****a 7
Andy Teucher a****r@g****a 5
Nadine Hussein n****3@g****m 3
repo-mountie[bot] 4****] 1
Eduard Szöcs E****D 1
Daniel S. Katz d****z@i****g 1
Azizishirazi A****H@B****V 1

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 203
Total pull requests: 103
Average time to close issues: 8 months
Average time to close pull requests: 18 days
Total issue authors: 6
Total pull request authors: 7
Average comments per issue: 1.19
Average comments per pull request: 0.58
Merged pull request: 88
Bot issues: 21
Bot pull requests: 3

Past year issues: 6
Past year pull requests: 10
Past year average time to close issues: 4 months
Past year average time to close pull requests: 5 days
Past year issue authors: 3
Past year pull request authors: 2
Past year average comments per issue: 1.83
Past year average comments per pull request: 0.6
Past year merged pull request: 7
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/bcgov/shinyssdtools

Top Issue Authors

  • sebdalgarno (111)
  • joethorley (51)
  • repo-mountie[bot] (21)
  • elimillera (9)
  • aylapear (8)
  • eduardszoecs (3)

Top Pull Request Authors

  • sebdalgarno (42)
  • joethorley (24)
  • aylapear (19)
  • nadinehussein (6)
  • eduardszoecs (6)
  • danielskatz (3)
  • repo-mountie[bot] (3)

Top Issue Labels

  • Type: Enhancement (23)
  • Difficulty: 1 Simple (21)
  • Priority: 3 Medium (18)
  • Effort: 1 Low (18)
  • Priority: 4 Low (12)
  • Effort: 2 Medium (12)
  • Type: Docs (10)
  • Difficulty: 2 Intermediate (9)
  • Effort: 3 High (7)
  • Difficulty: 3 Advanced (7)
  • Priority: 1 Critical (6)
  • Type: Testing (3)
  • Priority: 2 High (1)

Top Pull Request Labels


Dependencies

DESCRIPTION cran
  • R >= 3.5 depends
  • ssdtools >= 1.0.1 depends
  • DT * imports
  • RColorBrewer * imports
  • dplyr * imports
  • ggplot2 * imports
  • glue * imports
  • lifecycle * imports
  • magrittr * imports
  • markdown * imports
  • readr * imports
  • rhandsontable * imports
  • shiny * imports
  • shinyjs * imports
  • stats * imports
  • waiter * imports
  • covr * suggests
  • knitr * suggests
  • rmarkdown * suggests
  • rsconnect * suggests
  • ssddata * suggests
  • testthat * suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/deploy-app.yaml actions
  • 8398a7/action-slack v3.0.0 composite
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc master composite
  • r-lib/actions/setup-r master composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.4.1 composite
  • actions/checkout v3 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite

Score: 4.787491742782047