Compared to RAVESubjectBaseRepository, this repository
requires epoch information. please use
prepare_subject_with_epochs to instantiate this repository.
The root directory where the files are stored.
A named map, typically with data arrays, shape/dimension information
ravepipeline::RAVESerializable -> ravecore::RAVESubjectRepository -> RAVESubjectEpochRepository
needs_updatewrite-only attribute when subject needs to be
reloaded from the disk and reference table needs to be updated, use
repo$needs_update <- TRUE
sample_ratesa named list of sampling frequencies; the names
are signal types ('LFP', 'Auxiliary', or 'Spike')
and the values are the sampling frequencies
sample_ratea single number of the sample rate; if the electrode
channels contain local-field potential 'LFP' signal type, then
the sample rate is the 'LFP' sample rate; otherwise the
sample rate is 'Spike' channel sample rate, if exists, or whatever
comes first. This field is for backward compatibility support, use
sample_rates for more accurate number
epoch_namename of the epoch table
epochRAVEEpoch instance
epoch_tableepoch table, equivalent to
repository$epoch$table
stitch_eventsevents where time_windows are based on
time_windowslist of time ranges to load; the time is relative
to stitch_events; default is trial onset
electrode_tablethe entire electrode table with reference information
electrode_instanceselectrode channel instance helpers for loading electrode data
reference_instancesinstances of reference channels, for
referencing on the fly, used for electrode_instances
digest_keya list of repository data used to generate repository signature
@marshal()Internal method
RAVESubjectEpochRepository$@marshal(...)...internal arguments
@unmarshal()Internal method
RAVESubjectEpochRepository$@unmarshal(object, ...)object, ...internal arguments
new()constructor
RAVESubjectEpochRepository$new(
subject,
electrodes = NULL,
reference_name = NULL,
epoch_name = NULL,
time_windows = NULL,
stitch_events = NULL,
...,
quiet = FALSE,
repository_id = NULL,
strict = TRUE,
lazy_load = FALSE,
.class = NULL
)subject'RAVE' subject
electrodesstring or integers indicating electrodes to load
reference_namename of the reference table
epoch_namename of the epoch trial table
time_windowsnumeric vector with even lengths, the time start
and end of the trials, for example, c(-1, 2) means load
1 second before the trial onset and 2 seconds after trial onset
stitch_eventsevents where the time_windows is based;
default is trial onset (NULL)
...passed to RAVESubjectBaseRepository constructor
quietsee field quiet
repository_idsee field repository_id
strictwhether the mode should be strict; default is true and errors out when subject is missing
lazy_loadwhether to delay (lazy) the evaluation mount_data
.classinternally used, do not set, even if you know what this is
export_matlab()Export the repository to 'Matlab' for future analysis
RAVESubjectEpochRepository$export_matlab(..., verbose = TRUE)...reserved for child classes
verboseprint progresses
set_epoch()change trial epoch profiles
RAVESubjectEpochRepository$set_epoch(epoch_name, stitch_events = NULL)epoch_namename of epoch table
stitch_eventsevents to stitch
mount_data()function to mount data, not doing anything in this class, but may be used by child classes
RAVESubjectEpochRepository$mount_data(..., force = TRUE, electrodes = NULL)...reserved
forceforce update data; default is true
electrodeselectrodes to update; default is NULL (all
electrode channels)
get_container()get container where loaded data are stored
RAVESubjectEpochRepository$get_container(force = FALSE, ...)force, ...passed to mount_data
clone()The objects of this class are cloneable with this method.
RAVESubjectEpochRepository$clone(deep = FALSE)deepWhether to make a deep clone.
prepare_subject_with_epochs