hist_records: A function that generates histograms of Logie counter data

View source: R/hist_records.R

hist_recordsR Documentation

A function that generates histograms of Logie counter data

Description

This function generates histograms of ups, downs, or events separated by channel for Logie counter data.

Usage

hist_records(
  dataset,
  description,
  first_day = NULL,
  last_day = NULL,
  min_pss = NULL,
  max_pss = NULL,
  print_to_file = FALSE
)

Arguments

dataset

The cleaned counter dataset used to populate histograms (i.e., counter_data as created by bind_counter_data()).

description

The type of counter data to be plotted. Must be "U" (ups), "D" (downs), or "E" (events).

first_day

The first day of the dataset to be plotted, which must be specified in year-day (yday) format. Defaults to the first day in the dataset.

last_day

The last day of the dataset to be plotted, which must be specified in year-day (yday). Defaults to the last day in the dataset.

min_pss

The lower threshold peak signal size (pss) to be plotted. Defaults to 0.

max_pss

The upper threshold peak signal size (pss) to be plotted. Defaults to 130.

print_to_file

If TRUE, the histogram is saved to the working directory. Defaults to FALSE.

Value

Returns a histogram of peak signal size for either up counts, down counts, or events for each counter channel. The histograms and a summary of the total number of events per channel are printed to the console.


InStreamFisheries/FishCounter2 documentation built on Dec. 15, 2024, 9:23 p.m.