formatEffort: Format Detection Effort

In PAMscapes: Tools for Summarising and Analysing Soundscape Data

Format Detection Effort

Description

Format effort data for use in other acoustic detection plotting functions. Time ranges will be marked as either "on" or "off" effort

Usage

formatEffort(
  effort,
  range = NULL,
  resolution = NULL,
  columns = NULL,
  combineYears = FALSE
)

Arguments

effort	dataframe with columns start and end describing on effort time ranges
range	if not NULL, the full extent time ranges to consider for marking off effort times
resolution	if not NULL, time resolution to round effort start and end times to. Start times will use floor_date and end times will use ceiling_date, must be a character that is valid for the unit argument of those functions
columns	if not NULL, extra columns to use for differentiating different types of effort that should be tracked separately (e.g. different deployment sites or species with different effort)
combineYears	logical flag to combine all years into a single "year"

Value

a dataframe with columns start, end, and status which is either "on" or "off", as well as any columns listed in columns

Author(s)

Taiki Sakai [e-mail]

PAMscapes documentation built on April 4, 2025, 2:17 a.m.