bbousuite

A set of R packages to facilitate simulation and analysis of boreal caribou survival and recruitment data to estimate population growth.
https://github.com/poissonconsulting/bbousuite

Category: Biosphere
Sub Category: Terrestrial Wildlife

Keywords from Contributors

species-sensitivity-distribution ecotoxicology ssd water-quality-guideline

Last synced: about 8 hours ago
JSON representation

Repository metadata

Easily install and load bbou (boreal caribou) R packages

README.Rmd

          ---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  fig.width = 5,
  fig.height = 4
)
library(bboutools)
```

# bbousuite


[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![R-CMD-check](https://github.com/poissonconsulting/bbousuite/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/poissonconsulting/bbousuite/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/poissonconsulting/bbousuite/branch/main/graph/badge.svg)](https://app.codecov.io/gh/poissonconsulting/bbousuite?branch=main)


The goal of `bbousuite` is to make it easy to install and load the (`bbou`) suite of
R packages for **B**oreal cari**BOU**.

The `bbou`suite is a set of R packages to facilitate simulation and analysis of boreal caribou survival and recruitment data to estimate population growth.  

It consists of:  

- [`bboudata`](https://poissonconsulting.github.io/bboudata/), a collection of simulated and anonymized empirical survival and recruitment datasets.  
- [`bboutools`](https://poissonconsulting.github.io/bboutools/), a set of functions to estimate population growth in a Bayesian or Maximum Likelihood (ML) framework, implemented under the hood using the [Nimble](https://r-nimble.org) R package.  
- [`bboushiny`](https://poissonconsulting.github.io/bboushiny/), a Graphical User Interface (GUI) to `bboutools`.    
- [`bbouretro`](https://poissonconsulting.github.io/bbouretro/), a set of functions to estimate population growth using traditional frequentist methods.  
- [`bbousims`](https://poissonconsulting.github.io/bbousims/), a set of functions to simulate survival and recruitment data from hypothetical radio-collaring and composition surveys.  

Each R package has a website with function documentation and a 'Get Started' guide.  
If you are completely new to the `bbou` suite, we recommend taking a look at the [bboutools 'Get Started' guide](https://poissonconsulting.github.io/bboutools/articles/bboutools.html) as this demonstrates core functionality and methods.

There are also several vignettes, including `bboutools` [analytical methods](https://poissonconsulting.github.io/bboutools/articles/methods.html) and [prior selection](https://poissonconsulting.github.io/bboutools/articles/priors.html), `bbouretro` [analytical methods](https://poissonconsulting.github.io/bbouretro/articles/retro-methods.html), using [`bbousims` with `bboutools`](https://poissonconsulting.github.io/bbousims/articles/bboutools.html), and comparison of Bayesian and traditional method estimates with [empirical](https://poissonconsulting.github.io/bbousuite/articles/empirical-comparisons.html) and [simulated](https://poissonconsulting.github.io/bbousuite/articles/simulations.html) data. 


## Installation

You can install the latest version of `bbousuite` from [GitHub](https://github.com/poissonconsulting/bbousuite) with:

``` r
# install.packages("remotes")
remotes::install_github("poissonconsulting/bbousuite")
```

## Load

To load `bbousuite`

```{r}
library(bbousuite)
```

### Packages

The packages installed and loaded by `bbousuite` suite are:

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

## Inspiration

`bbousuite` was inspired by the [`tidyverse`](https://github.com/tidyverse/tidyverse) package.

## Getting Help or Reporting an Issue

To report bugs/issues/feature requests, please file an [issue](https://github.com/poissonconsulting/bbousuite/issues/).

## How to Contribute

If you would like to contribute to the package, please see our 
[CONTRIBUTING](https://github.com/poissonconsulting/bbousuite/blob/master/.github/CONTRIBUTING.md) guidelines.

## Code of Conduct

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

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

        

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 3 days ago

Total Commits: 139
Total Committers: 6
Avg Commits per committer: 23.167
Development Distribution Score (DDS): 0.338

Commits in past year: 110
Committers in past year: 5
Avg Commits per committer in past year: 22.0
Development Distribution Score (DDS) in past year: 0.164

Name Email Commits
Seb Dalgarno s****b@p****a 92
Joe Thorley j****e@p****a 20
Ayla Pearson a****a@p****a 15
Sarah Lyons s****h@p****a 6
Duncan Kennedy d****n@p****a 4
Nicole Hill n****e@p****a 2

Committer domains:


Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 4
Total pull requests: 15
Average time to close issues: 7 days
Average time to close pull requests: 22 days
Total issue authors: 2
Total pull request authors: 5
Average comments per issue: 1.25
Average comments per pull request: 0.2
Merged pull request: 15
Bot issues: 0
Bot pull requests: 0

Past year issues: 4
Past year pull requests: 13
Past year average time to close issues: 7 days
Past year average time to close pull requests: 21 days
Past year issue authors: 2
Past year pull request authors: 4
Past year average comments per issue: 1.25
Past year average comments per pull request: 0.23
Past year merged pull request: 13
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/poissonconsulting/bbousuite

Top Issue Authors

  • sebdalgarno (2)
  • see24 (2)

Top Pull Request Authors

  • sebdalgarno (8)
  • aylapear (3)
  • sarahLy9 (2)
  • joethorley (1)
  • nehill197 (1)

Top Issue Labels

Top Pull Request Labels


Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.5.0 composite
  • actions/checkout v4 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v4 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION cran
  • bboudata * imports
  • bbouretro * imports
  • bboushiny * imports
  • bbousims * imports
  • bboutools * imports
  • testthat >= 3.0.0 suggests
.github/workflows/paper.yaml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v1 composite
  • openjournals/openjournals-draft-action master composite

Score: 2.4849066497880004