README.md

In USFWS/escapement: Analyze and Report on Salmon Abundances using Photo and Video Count Data

escapement

Overview

An R package that includes functions for estimating salmon passage and abundances using photo and video count data based on Deacy et al. 2016., functions for summarizing and plotting results, and the ability to generate a parameterized rmarkdown report.

Installation

The escapement package requires several programs to function:

1. R (>=4.0)

2. Rtools 40

3. the tinyTex R package. To install it from R: a. if (!require("tinytex")) install.packages("tinytex") b. tinytex::install_tinytex()

To install and load the escapement R package: if (!require("devtools")) install.packages("devtools") devtools::install_github("USFWS/escapement", ref = "master", build_vignettes = TRUE) library(escapement)

Usage

To get started using escapement, read the Getting Started article in the GitHub page.

Getting help

You can view a help file in R for each function with `?{function-name}. Contact the project maintainer for additional help with this R package.

Contribute

Contact the project maintainer for information about contributing to this repository template. Submit a GitHub Issue to report a bug or request a feature or enhancement.

This work is licensed under a Creative Commons Attribution 1.0 International License.

USFWS/escapement documentation built on Nov. 9, 2024, 5:32 p.m.