bboushiny/README.Rmd at main · poissonconsulting/bboushiny · GitHub

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
---
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%"
)
library(bboushiny)
```

# bboushiny

<!-- badges: start -->
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![R-CMD-check](https://github.com/poissonconsulting/bboushiny/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/poissonconsulting/bboushiny/actions/workflows/R-CMD-check.yaml)
[![Test App Deployed](https://github.com/poissonconsulting/bboushiny/workflows/deploy-app/badge.svg)](https://github.com/poissonconsulting/bboushiny/actions)
[![Codecov test coverage](https://codecov.io/gh/poissonconsulting/bboushiny/branch/main/graph/badge.svg)](https://app.codecov.io/gh/poissonconsulting/bboushiny?branch=main)
<!-- badges: end -->

An R shiny app for estimating Boreal Caribou Population Growth from survival and recruitment data.
`bboushiny` is a simple and easy to use user interface for the [`bboutools`](https://github.com/poissonconsulting/bboutools) package.
Check out the [`bboutools`](https://github.com/poissonconsulting/bboutools) package which contains more options for customizing the models.

## Usage

### How to Install the R Package

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

```{r, eval=FALSE}
# install.packages("remotes")
remotes::install_github("poissonconsulting/bboushiny")
```

The package must be installed first before the app can be launched.

### How to Launch the App

#### Deployed App

The current working version of the app is available at [https://poissonconsulting.shinyapps.io/bboushiny/](https://poissonconsulting.shinyapps.io/bboushiny/).

#### Using Code

Run the `run_bbou_app()` function.

```{r, eval=FALSE}
# install.packages("bboushiny")
library(bboushiny)
run_bbou_app()
```

#### Using RStudio Addins Button

Click on the Addins drop-down and select Start bboushiny App

<img src="man/figures/addins.png" alt="addin-screenshot" width="600"/>

### Overview of How to Use the App

- Download the data templates for survival and recruitment
- Fill in the template with data
- Upload your data in each tab and generate estimates
- Generate estimates for Population Growth
- Download the results

<img src="man/figures/app-home-page.png" alt="app-home-screenshot"/>

## bbou Suite

`bboushiny` is part of the bbou suite of tools.
Other packages in this suite include:

- [bboudata](https://github.com/poissonconsulting/bboudata)
- [bboutools](https://github.com/poissonconsulting/bboutools)
- [bbouretro](https://github.com/poissonconsulting/bbouretro)
- [bbousims](https://github.com/poissonconsulting/bbousims)

## Contribution

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


## Code of Conduct

Please note that the bboushiny 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.

```{r, results = "asis", echo = FALSE}
cat(licensing_md())
```