Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bcgov/shinyssdtools

Shiny interface to ssdtools R package
https://github.com/bcgov/shinyssdtools

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

Last synced: 3 months ago
JSON representation

Shiny interface to ssdtools R package

Host: GitHub
URL: https://github.com/bcgov/shinyssdtools
Owner: bcgov
License: apache-2.0
Created: 2018-02-06T19:11:24.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2024-06-29T01:07:12.000Z (4 months ago)
Last Synced: 2024-08-01T01:57:22.147Z (3 months ago)
Topics: env, species-sensitivity-distribution, ssd, water-quality-guideline
Language: HTML
Homepage: https://bcgov.github.io/shinyssdtools/
Size: 13.1 MB
Stars: 7
Watchers: 5
Forks: 4
Open Issues: 6
Metadata Files:
- Readme: README.Rmd
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Support: .github/SUPPORT.md

Awesome Lists containing this project

jimsghstars - bcgov/shinyssdtools - Shiny interface to ssdtools R package (HTML)
open-sustainable-technology - 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. (Natural Resources / Water Supply and Quality)

README

        ---

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

## 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.

-----


ssdtools by the Province of British Columbia

 is licensed under a 

Creative Commons Attribution 4.0 International License.