filterData: Run filter on any StoX related data source

Description Usage Arguments Value

View source: R/Filter.R

Description

Run filter on any StoX related data source

Usage

1
2
3
4
5
6
filterData(
  inputData,
  filterExpression,
  propagateDownwards = TRUE,
  propagateUpwards = FALSE
)

Arguments

inputData

An input data. Can be a list of biotic data (StoX data type BioticData), list of acoustic data, StoxBiotic data, or StoxAcoustic data.

filterExpression

Filter expression in list of strings. The name of the list and structures should be identical to the names of the input data list.

propagateDownwards

Whether the filter action will propagate in the downwards direction. Default to TRUE.

propagateUpwards

Whether the filter action will propagate in the upwards direction. Default to FALSE.

Value

An object of filtered data in the same format as the input data.


RstoxData documentation built on July 17, 2021, 5:08 p.m.