summarize_btf: Summarize Bethel Test Fishery CPUE data

View source: R/summarize-btf.R

summarize_btfR Documentation

Summarize Bethel Test Fishery CPUE data

Description

Obtains a species-specific summary in terms of either proportional composition or daily CPUE with the ability to average over a several day window to smooth out daily variability.

Usage

summarize_btf(date, stat, plus_minus = 0)

Arguments

date

Datetime; the date to summarize. Must be of length 1. If plus_minus > 0, becomes the center of window across which the average is calculated.

stat

Character; the summary stat/species combination to return. Must be of length 1. Accepted values are:

  • "chinook_cpue" – returns the daily CPUE of Chinook salmon, averaged over a window if plus_minus > 0

  • "chum_cpue"

  • "sockeye_cpue"

  • "total_cpue"

  • "chinook_comp" – returns proportion of all daily CPUE made up of Chinook salmon, averaged over a window if plus_minus > 0

  • "chum_comp"

  • "sockeye_comp"

plus_minus

Numeric; the number of days before and after date to include in the average statistic returned. Must be of length 1. plus_minus = 0 (default) will return the observed daily value, plus_minus = 1 will return a three day average with date as the center day. Greater values of plus_minus will introduce more smoothing of between-day variability.


bstaton1/KuskoHarvData documentation built on Aug. 15, 2024, 3:29 p.m.