https://github.com/poissonconsulting/shinyypr

An R package to run ypr Shiny App
https://github.com/poissonconsulting/shinyypr

shiny

Last synced: 4 months ago
JSON representation

An R package to run ypr Shiny App

• Host: GitHub
• URL: https://github.com/poissonconsulting/shinyypr
• Owner: poissonconsulting
• License: other
• Created: 2019-12-20T23:07:30.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-11-01T15:54:32.000Z (5 months ago)
• Last Synced: 2024-12-04T05:39:52.142Z (4 months ago)
• Topics: shiny
• Language: R
• Homepage: https://poissonconsulting.github.io/shinyypr/
• Size: 302 KB
• Stars: 3
• Watchers: 5
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Support: .github/SUPPORT.md

Awesome Lists containing this project

• jimsghstars - poissonconsulting/shinyypr - An R package to run ypr Shiny App (R)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# shinyypr 

[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)

[![R build status](https://github.com/poissonconsulting/shinyypr/workflows/R-CMD-check/badge.svg)](https://github.com/poissonconsulting/shinyypr/actions)

[![Codecov test coverage](https://codecov.io/gh/poissonconsulting/shinyypr/branch/master/graph/badge.svg)](https://codecov.io/gh/poissonconsulting/shinyypr?branch=master)

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/license/mit/)

[![CRAN status](https://www.r-pkg.org/badges/version/shinyypr)](https://cran.r-project.org/package=shinyypr)

![CRAN downloads](https://cranlogs.r-pkg.org/badges/shinyypr)

## Introduction

shinyypr is an R package that provides a user interface to the [ypr](https://github.com/poissonconsulting/ypr) R package. [ypr](https://github.com/poissonconsulting/ypr) implements equilibrium-based yield per recruit methods for estimating the optimal yield for a fish population.

## Installation

To install the latest release from [CRAN](https://cran.r-project.org)

```{r, eval=FALSE, echo=FALSE}

install.packages("shinyypr")

```

To install the developmental version from [GitHub](https://github.com/poissonconsulting/shinyypr)

```{r, eval=FALSE}

install.packages("remotes")

remotes::install_github("poissonconsulting/shinyypr")

```

## Demonstration

```{r, eval=FALSE}

### run app with default parameter settings

shinyypr::run_ypr_app()

### provide parameter settings by passing a ypr_population object to the run_ypr_app function

adams <- ypr::adams_bt_03

adams_adjusted <- ypr::ypr_population_update(adams, "Rk" = 5, "Linf" = 140)

shinyypr::run_ypr_app(adams_adjusted)

```

`shinyypr` also ships with an RStudio addin. 

## Information

For more information see the `ypr` R package [Get Started](https://poissonconsulting.github.io/ypr/articles/ypr.html) vignette.

## Contribution

Please report any [issues](https://github.com/poissonconsulting/shinyypr/issues).

[Pull requests](https://github.com/poissonconsulting/shinyypr/pulls) are always welcome.

## Code of Conduct

Please note that the shinyypr project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.