plot_events: A function that plots events per hour of Logie counter data

View source: R/plot_events.R

plot_eventsR Documentation

A function that plots events per hour of Logie counter data

Description

This function plots a time series of hourly events and up counts separated by channel for Logie counter data.

Usage

plot_events(
  dataset,
  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()).

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.

print_to_file

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

Value

Returns a list with time series plot and data frame of hourly events and up counts separated by channel for Logie counter data.


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