mount_demo_subject: Load Demo Subject According to Package Configuration File

In beauchamplab/rave: R Analysis and Visualization of 'ECOG/iEEG' Data

Load Demo Subject According to Package Configuration File

Description

Load Demo Subject According to Package Configuration File

Usage

mount_demo_subject(
  subject_code,
  project_name,
  force_reload_subject = FALSE,
  ...,
  download_url
)

## S3 method for class 'rave_module_debug'
mount_demo_subject(
  subject_code,
  project_name,
  force_reload_subject = FALSE,
  ...,
  download_url
)

## S3 method for class 'rave_running'
mount_demo_subject(...)

## S3 method for class 'rave_running_local'
mount_demo_subject(...)

Arguments

subject_code	optional, subject code
project_name	optional, project name
force_reload_subject	logical, whether to force reload subject even if another subject is loaded
...	further passed to rave_prepare
download_url	optional, web link to subject archive

Details

When debugging the 'RAVE' modules, it loads demo subject for debugging from according to settings file "inst/rave.yaml".

This function only function properly in 'rave_module_debug' mode. This means by default it raises errors. In other mode, for example 'rave_running', it does nothing.

Value

None

beauchamplab/rave documentation built on Feb. 23, 2024, 7:20 a.m.