shinyssdtools

shinyssdtools: A web application for fitting Species Sensitivity Distributions (SSDs) - Published in JOSS (2021)

https://github.com/bcgov/shinyssdtools

Keywords

Keywords from Contributors

Repository

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.

-----


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

Owner

JOSS Publication

shinyssdtools: A web application for fitting Species Sensitivity Distributions (SSDs)

Published

January 25, 2021

DOI

10.21105/joss.02848

Volume 6, Issue 57, Page 2848

Authors

Seb Dalgarno
Poisson Consulting Ltd., Nelson, British Columbia

Editor

Marcos Vital

Tags

Shiny ssdtools species sensitivity distributions

View PDF Review Thread Software Archive

GitHub Events

Committers

Last synced: 7 months ago

Issues and Pull Requests

Last synced: 6 months ago