Skip to contents

'RAVE' class for loading entire recording block repository

Source: R/class111-recording_blocks_repository.R
RAVESubjectRecordingBlockRepository.Rd

Compared to RAVESubjectBaseRepository, this repository requires specifying block information. please use prepare_subject_with_blocks to instantiate this repository.

Value

The root directory where the files are stored.

A named map, typically with data arrays, shape/dimension information

See also

prepare_subject_with_blocks

Super classes

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

Active bindings

needs_update

write-only attribute when subject needs to be reloaded from the disk and reference table needs to be updated, use repo$needs_update <- TRUE

blocks

names of recording blocks

electrode_table

the entire electrode table with reference information

digest_key

a list of repository data used to generate repository signature

Methods

Public methods

Inherited methods

Method @marshal()

Internal method

Usage

RAVESubjectRecordingBlockRepository$@marshal(...)

Arguments

...

internal arguments

Method @unmarshal()

Internal method

Usage

RAVESubjectRecordingBlockRepository$@unmarshal(object, ...)

Arguments

object, ...

internal arguments

Method new()

constructor

Usage

RAVESubjectRecordingBlockRepository$new(
  subject,
  electrodes = NULL,
  reference_name = NULL,
  blocks = NULL,
  ...,
  quiet = FALSE,
  repository_id = NULL,
  strict = TRUE,
  lazy_load = FALSE,
  .class = NULL
)

Arguments

subject

'RAVE' subject

electrodes

string or integers indicating electrodes to load

reference_name

name of the reference table

blocks

name of the recording blocks to load

...

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 export_matlab()

Export the repository to 'Matlab' for future analysis

Usage

RAVESubjectRecordingBlockRepository$export_matlab(..., verbose = TRUE)

Arguments

...

reserved for child classes

verbose

print progresses

Method get_container()

get container where loaded data are stored

Usage

RAVESubjectRecordingBlockRepository$get_container(force = FALSE, ...)

Arguments

force, ...

passed to mount_data

Method clone()

The objects of this class are cloneable with this method.

Usage

RAVESubjectRecordingBlockRepository$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.