sim.contract: Signal manipulation: contract

Description Usage Arguments Value See Also

View source: R/perturbations.R

Description

Contracts signal data. Given a baseline signal, this function separates signal values into segments of size N, with respect to time. Then, from each segment, i values from (1..N) are removed at random (unless j is not NULL, in which case always remove the j-th values in the given segment and disregard i).

Usage

1
2
sim.contract(baseline, i = 1, j = NULL, N = 2, reindex = FALSE,
  pruning_only = FALSE)

Arguments

baseline

baseline, as generated by function sim.baseline, possibly perturbed by other functions.

i

see description above. Defaults to 1.

j

see description above. Defaults to NULL.

N

see description above. Defaults to N.

reindex

Boolean, indicates whether time values should be re-indexed to 1..N after contraction.

pruning_only

Boolean, indicates whether the function should only use the specified parameters to remove events, but keep the time scale fixed. This is equivalent to using function sim.prune.

Value

Modified baseline input.

See Also

See functions beginning with sim.sample. for examples of usage.


davnovak/qctoy documentation built on Nov. 4, 2019, 9:45 a.m.