removeFunction: Remove a Function from a PAMpalSettings Object

In PAMpal: Load and Process Passive Acoustic Data

Remove a Function from a PAMpalSettings Object

Description

Remove a function from the "function" slot in a PAMpalSettings object.

Usage

removeFunction(pps, index = NULL)

Arguments

pps

a PAMpalSettings object to remove a function from

index

index indicating which function to move, counting from ClickDetector functions first, then WhistlesMoans functions, then Cepstrum functions. This is the same order functions appear in when examining the pps object. For example, if there are two Click functions and one Whistle function, the Whistle function would have an index of 3. If missing, user can select from a list. This can also be a vector to remove multiple functions at once.

Value

the same PAMpalSettings object as pps, with the function removed from the "functions" slot

Author(s)

Taiki Sakai [e-mail]

Examples

exPps <- new('PAMpalSettings')
exPps <- addFunction(exPps, roccaWhistleCalcs, module='WhistlesMoans')
exPps <- addFunction(exPps, standardCepstrumCalcs, module = 'Cepstrum')
removeFunction(exPps, 1)
removeFunction(exPps, 1:2)
# normally best to use interactively instead of specifying index
if(interactive()) removeFunction(exPps)

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