addAnnotation: Add Annotation Data to an AcousticStudy Object

In TaikiSan21/PAMr: Load and Process Passive Acoustic Data

Description

Adds annotation data to an AcousticStudy object, usually in preparation for exporting to an external source. Most pieces of the annotation form will be filled in by the user when the function is called, but lat, lon, time_start, time_end, freq_low, freq_high, source_id, and annotation_id will be filled in automatically based on data in each AcousticEvent. Annotations are stored for each event in the ancillary slot.

Usage

addAnnotation(x, annoList = NULL)

getAnnotation(x = NULL, notes = FALSE)

Arguments

x	an AcousticStudy object
annoList	an annotation list created by getAnnotation. Default NULL will create a blank list
notes	logical flag whether to pull a version of the list that only contains notes, should only be TRUE for internal use

Value

The same object as x with an $annotation item added the the ancillary slot of each event in x

Author(s)

Taiki Sakai [e-mail]

TaikiSan21/PAMr documentation built on Nov. 15, 2020, 9:46 p.m.