RAVESubject: Definition for 'RAVE' subject class

In dipterix/ravecore: Core of R analysis and Visualization of Human Intracranial Electroencephalography

Description

Definition for 'RAVE' subject class

Definition for 'RAVE' subject class

Active bindings

project

project instance of current subject; see RAVEProject

project_name

character string of project name

subject_code

character string of subject code

subject_id

subject ID: "project/subject"

path

subject root path

rave_path

'rave' directory under subject root path

meta_path

meta data directory for current subject

freesurfer_path

'FreeSurfer' directory for current subject. If no path exists, values will be NA

preprocess_path

preprocess directory under subject 'rave' path

data_path

data directory under subject 'rave' path

cache_path

path to 'FST' copies under subject 'data' path

epoch_names

possible epoch names

reference_names

possible reference names

reference_path

reference path under 'rave' folder

preprocess_settings

preprocess instance; see RAVEPreprocessSettings

blocks

subject experiment blocks in current project

electrodes

all electrodes, no matter excluded or not

raw_sample_rates

voltage sample rate

power_sample_rate

power spectrum sample rate

has_wavelet

whether electrodes have wavelet transforms

notch_filtered

whether electrodes are Notch-filtered

electrode_types

electrode types; see type field in RAVEAbstarctElectrode or LFP_electrode

Methods

Public methods

• RAVESubject$print()

• RAVESubject$new()

• RAVESubject$meta_data()

• RAVESubject$valid_electrodes()

• RAVESubject$initialize_paths()

• RAVESubject$clone()

---

Method print()

override print method

Usage

RAVESubject$print(...)

Arguments

...

ignored

---

Method new()

constructor

Usage

RAVESubject$new(project_name, subject_code = NULL, strict = TRUE)

Arguments

project_name

character project name

subject_code

character subject code

strict

whether to check if subject folders exist

---

Method meta_data()

get subject meta data located in "meta/" folder

Usage

RAVESubject$meta_data(
  meta_type = c("electrodes", "frequencies", "time_points", "epoch", "references"),
  meta_name = "default"
)

Arguments

meta_type

choices are 'electrodes', 'frequencies', 'time_points', 'epoch', 'references'

meta_name

if meta_type='epoch', read in 'epoch_<meta_name>.csv'; if meta_type='references', read in 'reference_<meta_name>.csv'.

Returns

data frame

---

Method valid_electrodes()

get valid electrode numbers

Usage

RAVESubject$valid_electrodes(reference_name, refresh = FALSE)

Arguments

reference_name

character, reference name, see meta_name in self$meta_data or load_meta when meta_type if 'reference'

refresh

whether to reload reference table before obtaining data, default is false

Returns

integer vector of valid electrodes

---

Method initialize_paths()

create subject's directories on hard disk

Usage

RAVESubject$initialize_paths(include_freesurfer = TRUE)

Arguments

include_freesurfer

whether to create 'FreeSurfer' path

---

Method clone()

The objects of this class are cloneable with this method.

Usage

RAVESubject$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

load_meta

dipterix/ravecore documentation built on Aug. 5, 2020, 2:14 p.m.