plotPolarDetections: Plot Detections in a Polar Plot
In PAMscapes: Tools for Summarising and Analysing Soundscape Data

plotPolarDetections

R Documentation

Plot Detections in a Polar Plot

Description

Plots detection data in a polar plot where the circular (angular) axis is either the hour of day or month of the year

Usage

plotPolarDetections(
  x,
  bin = c("days/month"),
  detectedValue = NULL,
  quantity = c("count", "mean", "effort", "percentEffort", "percentTotal"),
  group = c("species", "deployment"),
  facet = NULL,
  effort = NULL,
  matchEffort = TRUE,
  title = NULL,
  returnData = FALSE,
  verbose = TRUE
)

Arguments

`x`	dataframe of data loaded with loadDetectionData
`bin`	character specification of the radial and circular (angular) dimensions of the plot in the form "bin1/bin2", where "bin1" is one of "detection", "hour", or "day", and "bin2" is one of "hour" or "month". "bin1" is the units of the radial axis, and "bin2" is the unit of the circular axis. If "bin1" is "detection", then each row is treated as a distinct instantaneous detection, otherwise calls are binned using binDetectionData.
`detectedValue`	values in the "detectedFlag" column of `x` that should be considered positive detections, ignored if that column is not in your data. If `NULL` then all rows are assumed to be positive detections
`quantity`	character indicating what type of quantity to plot. "count" plots total detections, "mean" plots average detections across `group`s, "effort" plots amount of total effort, "percentTotal" plots number of detections as a percent of total detections, "percentEffort" plots percent of total effort with detections.
`group`	a vector of name(s) of columns in `x` indicating which rows are distinct from eachother, used for binning data and accounting for effort. Typically something like "species", "site", or both
`facet`	optional name of column to facet output plot by
`effort`	Not relevant for `quantity` "count or "percentTotal", or `bin` with "detection". If not `NULL`, a dataframe describing on effort times to be formatted with formatEffort. If effort data is not provided then times with zero detections will not be properly accounted for. Alternatively, if columns "effortStart" and "effortEnd" are present in `x`, then these values will be used for start and end of effort
`matchEffort`	if `TRUE`, only rows of `effort` that match `group` and `facet` levels of `x` will be included. If `FALSE`, all rows of `effort` will be assumed to be relevant. Typically this should only be `FALSE` if there are times of effort where there are no detections in `x` (and thus no `group` or `facet` level to match to for that instance)
`title`	optional title for plot
`returnData`	if `TRUE` then no plot will be generated, instead the dataframe that would normally be used to make the plot will be returned
`verbose`	logical flag to print messages