Skip to contents

'RAVE' class for blocks of voltage repository

Source: R/class112-recording_blocks_rawvoltage.R
RAVESubjectRecordingBlockRawVoltageRepository.Rd

Compared to RAVESubjectBaseRepository, this repository loads the entire voltage traces for selected blocks; use prepare_subject_raw_voltage_with_blocks to instantiate this repository.

See also

prepare_subject_raw_voltage_with_blocks

Super classes

ravepipeline::RAVESerializable -> ravecore::RAVESubjectRepository -> ravecore::RAVESubjectRecordingBlockRepository -> RAVESubjectRecordingBlockRawVoltageRepository

Active bindings

reference_name

name of reference table; always 'noref'

reference_table

reference table; a reference table with 'noref' on all channels

references_list

a vector of reference channel names; always 'noref'

reference_instances

instances of reference channels, empty in this type of repositories

sample_rates

a named list of sampling frequencies; the names are signal types ('LFP', 'Auxiliary', or 'Spike') and the values are the sampling frequencies

raw_voltage

data container, alias of get_container

Methods

Public methods

Inherited methods

Method @marshal()

Internal method

Usage

RAVESubjectRecordingBlockRawVoltageRepository$@marshal(...)

Arguments

...

internal arguments

Method @unmarshal()

Internal method

Usage

RAVESubjectRecordingBlockRawVoltageRepository$@unmarshal(object, ...)

Arguments

object, ...

internal arguments

Method new()

constructor

Usage

RAVESubjectRecordingBlockRawVoltageRepository$new(
  subject,
  electrodes = NULL,
  reference_name = "noref",
  blocks = NULL,
  downsample = NA,
  ...,
  quiet = TRUE,
  repository_id = NULL,
  strict = TRUE,
  lazy_load = FALSE,
  .class = NULL
)

Arguments

subject

'RAVE' subject

electrodes

string or integers indicating electrodes to load

reference_name

always 'noref' (no reference); trying to set to other values will result in a warning

blocks

name of the recording blocks to load

downsample

down-sample rate by this integer number to save space and speed up computation; typically 'ERP' signals do not need super high sampling frequencies to load; default is NA and no down-sample is performed.

...

passed to RAVESubjectBaseRepository constructor

quiet

see field quiet

repository_id

see field repository_id

strict

whether the mode should be strict; default is true and errors out when subject is missing

lazy_load

whether to delay (lazy) the evaluation mount_data

.class

internally used, do not set, even if you know what this is

Method mount_data()

function to mount data

Usage

RAVESubjectRecordingBlockRawVoltageRepository$mount_data(
  ...,
  force = TRUE,
  electrodes = NULL
)

Arguments

...

reserved

force

force update data; default is true; set to false to use cache

electrodes

electrodes to update; default is NULL (all electrode channels)

Method clone()

The objects of this class are cloneable with this method.

Usage

RAVESubjectRecordingBlockRawVoltageRepository$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.