https://github.com/pacificcommunity/ofp-sam-ample
Repository for the AMPLE harvest control rule R-Shiny apps
https://github.com/pacificcommunity/ofp-sam-ample
ofp sam shiny
Last synced: about 1 year ago
JSON representation
Repository for the AMPLE harvest control rule R-Shiny apps
- Host: GitHub
- URL: https://github.com/pacificcommunity/ofp-sam-ample
- Owner: PacificCommunity
- License: gpl-3.0
- Created: 2022-11-23T22:39:42.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-03T00:14:57.000Z (over 2 years ago)
- Last Synced: 2025-04-01T13:17:38.574Z (about 1 year ago)
- Topics: ofp, sam, shiny
- Language: HTML
- Homepage:
- Size: 2.53 MB
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
Awesome Lists containing this project
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# AMPLE
AMPLE provides three Shiny apps to explore how Harvest Control Rules (HCRs) work and how performance indicators can be used to select between them.
The three apps are:
* *Introduction to HCRs* provides a simple overview to how HCRs work. Users are able to select their own HCR and step through its performance, year by year. Biological variability and estimation error are introduced.
* *Measuring performance* builds on the previous app and introduces the idea of using performance indicators to evaluate HCR performance.
* *Comparing performance* allows multiple HCRs to be created and tested, and their performance compared so that the preferred HCR can be selected.
## Installation
You can install the released version of AMPLE from [CRAN](https://CRAN.R-project.org) with:
``` r
install.packages("AMPLE")
```
Alternatively, you can get the latest version from the GitHub repository [here](https://github.com/PacificCommunity/ofp-sam-ample//) by installing it with the *devtools* package.
``` r
devtools::install_github("PacificCommunity/ofp-sam-ample")
```
## Usage
Load the library as usual:
```{r eval=FALSE}
library(AMPLE)
```
The apps can be launched by calling the appropriate function:
```{r eval=FALSE}
intro_hcr()
```
```{r eval=FALSE}
measuring_performance()
```
```{r eval=FALSE}
comparing_performance()
```
The apps are also hosted online at:
* https://ofp-sam.shinyapps.io/AMPLE-intro-hcr/
* https://ofp-sam.shinyapps.io/AMPLE-measuring-performance/
* https://ofp-sam.shinyapps.io/AMPLE-comparing-performance/
## Vignettes
There are three vignettes that walk users through the app.
These can be used in workshops etc to help learning.
You can access them from R using:
```{r eval=FALSE}
vignette("intro_hcr", package="AMPLE")
vignette("measuring_performance", package="AMPLE")
vignette("comparing_performance", package="AMPLE")
```
The vignettes are also accessible through the Shiny apps, under the 'Information' tab.