byMethods: Set of methods to apply a function over an Experiment object

In GiBacci/expR:

Set of methods to apply a function over an Experiment object

Description

The Experiment is used as environment for evaluating the function call and won't be used as input to the function.

bySample the function is called splitting the experiment into sample/s.

byRun the function is called splitting the experiment into run/s.

byFct the function is called splitting the experiment according to the factor provided.

byAll the function is called using all files as input/output.

byFile the function is called on each file separately.

Usage

bySample(obj, fun, ..., thread = 1)

byRun(obj, fun, ..., thread = 1)

byFct(obj, fun, by, ..., thread = 1)

byAll(obj, fun, ..., thread = 1)

byFile(obj, fun, ..., thread = 1)

Arguments

obj	Experiment
fun	function, the function that will be applied to each subset of the Experiment
...	additional parameters to fun
thread	integer, the number of parallel process to execute
by	a factor. The experiment will be spitted according to this factor

Details

If threads > 1 and the doMC package has been installed, multiple processes will be executed at the same time.

Value

a list. The length of the list depends on the factor used to split the experiment. byAll returns a single object.

GiBacci/expR documentation built on Oct. 15, 2022, 12:15 a.m.