removeNote: removeNote

View source: R/removeNote.R

removeNoteR Documentation

removeNote

Description

Remove a note added with addNote

Usage

removeNote(x, index)

Arguments

x

An AcousticStudy or AcousticEvent object

index

The index of the note to remove, order matches the output of getNotes

Value

For addNote, the same data as x, with notes added. For getNotes, a list of all notes present in x

Author(s)

Taiki Sakai taiki.sakai@noaa.gov

Examples


data(exStudy)
exStudy <- addNote(exStudy, to='study', label='Note1',
                   note='My first note for this study')
exStudy <- addNote(exStudy, to='event', evNum=1:2, label='Note2',
                   note='A note for the first two events')
exStudy
removeNote(exStudy, 1)
removeNote(exStudy, 2)
removeNote(exStudy, 3)


PAMpal documentation built on Aug. 12, 2023, 1:06 a.m.