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

Description Usage Arguments Value See Also Examples

View source: R/detectionSummary.R

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

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

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.

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
## 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

vinayudyawer/ATT documentation built on Oct. 8, 2020, 3:48 p.m.