Prepare 'RAVE' single-subject data
Source:R/rave-prepare-subjectbare.R, R/rave-prepare-subjectblock.R, R/rave-prepare-subjectphase.R, and 4 more
rave-prepare.RdPrepare 'RAVE' single-subject data
Usage
prepare_subject_bare0(
subject,
electrodes,
reference_name,
...,
quiet = TRUE,
repository_id = NULL
)
prepare_subject_bare(
subject,
electrodes,
reference_name,
...,
repository_id = NULL
)
prepare_subject_with_epoch(
subject,
electrodes,
reference_name,
epoch_name,
time_windows,
stitch_events = NULL,
env = parent.frame(),
...
)
prepare_subject_with_blocks(
subject,
electrodes,
reference_name,
blocks,
raw = FALSE,
signal_type = "LFP",
time_frequency = (!raw && signal_type == "LFP"),
quiet = raw,
env = parent.frame(),
repository_id = NULL,
...
)
prepare_subject_phase(
subject,
electrodes,
reference_name,
epoch_name,
time_windows,
stitch_events = NULL,
signal_type = c("LFP"),
env = parent.frame(),
verbose = TRUE,
...
)
prepare_subject_power(
subject,
electrodes,
reference_name,
epoch_name,
time_windows,
stitch_events = NULL,
signal_type = c("LFP"),
env = parent.frame(),
verbose = TRUE,
...
)
prepare_subject_wavelet(
subject,
electrodes,
reference_name,
epoch_name,
time_windows,
stitch_events = NULL,
signal_type = c("LFP"),
env = parent.frame(),
verbose = TRUE,
...
)
prepare_subject_raw_voltage_with_epoch(
subject,
electrodes,
epoch_name,
time_windows,
stitch_events = NULL,
...,
quiet = TRUE,
repository_id = NULL
)
prepare_subject_voltage_with_epoch(
subject,
electrodes,
epoch_name,
time_windows,
reference_name,
stitch_events = NULL,
...,
quiet = TRUE,
repository_id = NULL
)Arguments
- subject
character of project and subject, such as
"demo/YAB", orRAVESubjectinstance- electrodes
integer vector of electrodes, or a character that can be parsed by
parse_svec- reference_name
reference name to be loaded
- ...
ignored
- quiet
whether to quietly load the data
- repository_id
used internally
- epoch_name
epoch name to be loaded, or a
RAVEEpochinstance- time_windows
a list of time windows that are relative to epoch onset time; need to pass the validation
validate_time_window- stitch_events
events to stitch, default is
NULL, meaning when loading data, the time is relative to the trial onset (column"Time"in the epoch file); set to a character of length 2, representing the events if time is not relative to trial onset. Please remove the prefix. For example, for a column named"Event_name", the event name is"name".- env
environment to evaluate
- blocks
one or more session blocks to load
- raw
whether to load from original (before processing) data; if true, then time-frequency data will not be loaded.
- signal_type
electrode signal type (length of one) to be considered; default is 'LFP'. This option rarely needs to change unless you really want to check the power data from other types. For other signal types, check
SIGNAL_TYPES- time_frequency
whether to load time-frequency data when preparing block data
- verbose
whether to show progress
Value
A fastmap2 (basically a list) of objects.
Depending on the functions called, the following items may exist in the list:
subjectA
RAVESubjectinstanceepoch_nameSame as input
epoch_nameepochA
RAVEEpochinstancereference_nameSame as input
reference_namereference_tableA data frame of reference
electrode_tableA data frame of electrode information
frequencyA vector of frequencies
time_pointsA vector of time-points
power_listA list of power data of the electrodes
power_dimnamesA list of trial indices, frequencies, time points, and electrodes that are loaded