WrapMappingFuncAlong: Wrap a mapping function along specific axis to batch process...

In Crystal-YWu/abftools: ABF Tools: Toolbox for Visualising and Analysing Electrophysiology ABF2 Data

Description

The wrapped function has a signature of f(abf, intv = NULL, episode, channel) see details for more details.

Usage

WrapMappingFuncAlong(map_func, along = c("time", "episode", "channel"),
  pack_args = FALSE, abf_id_func = NULL,
  epi_id_func = DefaultEpiLabel, chan_id_func = DefaultChanLabel,
  time_unit = "tick", ret.df = TRUE, ...)

wrap_along(..., time_unit = "ms", ret.df = TRUE)

Arguments

map_func	a mapping function.
along	the axis to process along. Can be "time", "episode" or "channel".
pack_args	wheter to pack arguments for map_func, see PackArgs() for more details.
abf_id_func	OPTIONAL, a function accepts an abf object and returns an identifier of the objects.
epi_id_func	OPTIONAL, a function accepts an abf object and returns a vector of identifiers of all episodes.
chan_id_func	OPTIONAL, a function accepts an abf object and returns a vectors of identifiers of all channels.
time_unit	convert time unit of the return time axis.
ret.df	wheter to return a data.frame, a matrix is returned instead if set to FALSE.
...	further arguments passed to map_func.

Details

Arguments of the wrapped function f(abf, intv = NULL, episode, channel):

abf a abf object

intv OPTIONAL, a time interval to calcaulte. If NULL, the whole timespan is used.

episode OPTIONAL, a vector of episodes to calculate. If missing, all episodes are used.

channel OPTIONAL, a vector of channels to calculate. If missing, all channels are used.

Value

a function

Crystal-YWu/abftools documentation built on May 10, 2019, 8:22 a.m.