ep.eye_setup_proc_config: Read and setup processing configuration

View source: R/ep.eye_setup_proc_config.R

ep.eye_setup_proc_configR Documentation

Read and setup processing configuration

Description

Validates and imports processing configuration options into the environment for later use. Implements default configuration options if missing from YAML.

Usage

ep.eye_setup_proc_config(edf_raw, config_path, header = NULL)

Arguments

config_path

Path to corresponding .yml configuration file with processing instructions. Instructions on how to effectively set up a configuration file can be found [HERE].

file

Path to the .edf file to process.

Details

Also generates new log file using sink(), and sets up a new directory for preprocessed output if it does not already exist.

Value

Nested list with processing options pulled from .yml configuration file.

Author(s)

Nate Hall

importFrom stringr str_extract importFrom yaml read_yaml importFrom nate.utils print_tree

Examples

 ## Not run: 
   config <- setup_proc_configs("/proj/mnhallqlab/studies/NeuroMAP/s3_data/Neighborhood_PSU/eye/002_HS_Neighborhood_Eye.edf", "/proj/mnhallqlab/studies/NeuroMAP/s3_data_ep_specs/yaml/Neighborhood_PSU.yaml")
 
## End(Not run)

PennStateDEPENdLab/experiment_pipeline documentation built on Nov. 27, 2024, 4:56 a.m.