epochSeries: Extract series chunks corresponding to epochs

View source: R/categories_extraction.R

epochSeriesR Documentation

Extract series chunks corresponding to epochs

Description

epochSeries cycles through all sessions in an experiment. For each session extracts a series, then cuts it according to categories epochs

Usage

epochSeries(
  x,
  signal,
  sync,
  series,
  diary,
  category,
  mergeEpochs = FALSE,
  artefact.rm = TRUE,
  shift_start = 0,
  shift_end = 0,
  target = c("epoch", "before", "after"),
  summaryFUN = "median",
  ...
)

Arguments

x

a DyadExperiment object

signal

string. The name of a DyadSignal present in x

sync

If missing, series is searched in the signal (s1, s2, ...). If specified, series is searched within a sync object (PMBdev, CCFBest, ...).

series
diary
category
mergeEpochs
artefact.rm
shift_start

numeric. Seconds to shift all start values (e.g. -5 shifts all epoch starts by 5 seconds before )

shift_end

numeric. Seconds to shift all end values (e.g. 7.5 shifts all epoch end by 7.5 seconds later )

target

one of "epoch", "before", "after". Determines whether to extract the actual epochs or only what precedes or follows it. If it's not set to "epoch", shift_start or shift_end must be specified.

summaryFUN
...

kleinbub/rIP documentation built on Dec. 21, 2024, 9:15 a.m.