detectionSummary: Calculate standard metrics of detection using passive...

In RossDwyer/VTrack: A Collection of Tools for the Analysis of Passive Acoustic Telemetry Data

Calculate standard metrics of detection using passive telemetry data

Description

Produce standard metrics of detection. Metrics include Number of detections, Number of receiver stations detected on, Number of days detected, Number of Days at Liberty and Detection Index.

Usage

detectionSummary(ATTdata, sub = "%Y-%m", download_date = NULL)

Arguments

ATTdata	an 'ATT' object created using setupData containing tag detection data, metadata and station information
sub	argument to define temporal subsets. Temporal subsets are currently restricted to monthly ('%Y-%m') or weekly ('%Y-%W'). Defaults to monthly if none is provided.
download_date	date the array was downloaded in the form 'yyyy-mm-dd' for calculating detection summary before the collection of full dataset has been collected. If none provided, it is assumed complete data has been collected, and detection indices are calculated as such.

Value

Produces a list of tibbles containing Overall (full tag life) and Subsetted (user-defined temporal subsets) metrics of detection. Temporal subsets are currently restricted to monthly ('%Y-%m') or weekly ('%Y-%W').

See Also

Input data needs to be setup using setupData

Examples

## Import example datasets
data(IMOSdata)
data(taginfo)
data(statinfo)

## Setup data
ATTdata<- setupData(Tag.Detections = IMOSdata, 
                    Tag.Metadata = taginfo, 
                    Station.Information = statinfo, 
                    source = "IMOS")

## Estimate detecion metrics with monthly subsets chosen
dSum<-detectionSummary(ATTdata, sub = "%Y-%m")

## Metrics of detection for full tag life
dSum$Overall

## Metrics of detection for each temporal subset
dSum$Subsetted

## If the full dataset hasn't been collected yet, detection indicies
## can be calculated to the most recent date when the acoustic array
## was downloaded. Indicate latest download date in the format 'yyyy-mm-dd'
dSum_partial <- detectionSummary(ATTdata, download_date = "2014-01-01")

dSum_partial$Overall

dSum_partial$Subsetted

RossDwyer/VTrack documentation built on Feb. 23, 2024, 10:40 p.m.