plot_pss_hour: A function that plots average hourly peak signal size (pss)...

View source: R/plot_pss_hour.R

plot_pss_hourR Documentation

A function that plots average hourly peak signal size (pss) for Logie counter data

Description

This function plots the average hourly peak signal size (pss) for Logie counter data.

Usage

plot_pss_hour(
  dataset,
  description,
  first_day = NULL,
  last_day = NULL,
  min_pss = NULL,
  max_pss = NULL,
  ch = 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) format. Defaults to the last day in the dataset.

min_pss

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

max_pss

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

ch

The channel to be plotted. Defaults to all channels. Needs to be secified as an object or vector (e.g. 1, or c(1, 2)).

print_to_file

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

Value

Returns a list of two plots of average hourly pss data. One plot displays a time series of average hourly pss for all channels combined (as specified by ch). A second plot displays a time series of average hourly pss separated into each channel.


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