MeltAbf: Melt an abf object.

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

Description

Flatten an abf object to 2d data.frame by sampling along time dimension.

Usage

MeltAbf(abf, intv = NULL, channel = GetAllChannels(abf),
  episode = GetAvailEpisodes(abf), concat_epi = FALSE,
  along = c("episode", "channel"), format = c("wide", "long"),
  abf_id_func = NULL, epi_id_func = GetEpiTag,
  chan_id_func = GetChanTag, sample_ratio = 1L, sample_func = "mean",
  sample_colFunc = NULL, time_unit = c("tick", "us", "ms", "s", "min",
  "hr"), ..., value.name = "value")

Arguments

abf	an abf object.
intv	a time interval to melt.
channel	channels to melt.
episode	episodes to melt.
concat_epi	wheter to concatenate all episodes, if TRUE, episode arguement is ignored and all episodes will be used instead.
along	the axis/dimension to melt along.
format	the format of returned data.frame.
abf_id_func	function to tag id column.
epi_id_func	function to tag episode column.
chan_id_func	function to tag channel column.
sample_ratio	a sampling ratio if need to reduce data points.
sample_func	a sampling function if sample_ratio > 1.
sample_colFunc	a sampling column function.
time_unit	a time unit.
...	passed to sample_func or sample_colFunc.
value.name	a character vector to tag value column, only used when format is long.

Details

For performance consideration, using a column function by sample_colFunc or a function name supported by find_colFunc() is strongly encouraged.

Value

a data.frame

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