forked from bcgov/shinyssdtools
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
101 lines (68 loc) · 4.07 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# shinyssdtools
<!-- badges: start -->
[](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
[](https://github.com/bcgov/shinyssdtools/actions/workflows/R-CMD-check.yaml)
[](https://opensource.org/licenses/Apache-2.0)
[](https://doi.org/10.21105/joss.02848)
<!-- badges: end -->
`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 <https://bcgov-env.shinyapps.io/ssdtools/>.
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.
-----
<a rel="LICENSE" href="https://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons Licence"
style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/80x15.png" /></a><br /><span
xmlns:dct="http://purl.org/dc/terms/" property="dct:title">ssdtools</span> by <span
xmlns:cc="http://creativecommons.org/ns#" property="cc:attributionName">the Province of British Columbia
</span> is licensed under a <a rel="LICENSE" href="https://creativecommons.org/licenses/by/4.0/">
Creative Commons Attribution 4.0 International License</a>.