Function reference • rave

All functions
`ECoGRepository`	R6 class for `iEEG/ECoG` data Repository
`Electrode`	R6 Class for Electrode
`ExecEnvir`	Session-based Module Runtime Environment Class
`ModuleEnvir`	R6 'RAVE' Module Class
`Subject`	R6 Class for 'RAVE' Subject
`any_subject_loaded()`	Function to check if data repository has data
`archive_subject()`	Archive Subject into Zipped file
`arrange_data_dir()`	Initialize data repository
`arrange_modules()`	Update (optional), and check validity of modules
`as_subject()`	Make new subject object from character
`attachDefaultDataRepository()`	Attach subject data
`baseline()`	Baseline signals
`cache_raw_voltage()`	Import Subject "Matlab" File and Create "HDF5" files
`check_data_repo()`	Check if default data environment has object
`check_dependencies()`	Check and Install RAVE Dependencies
`check_epoch()`	Check if epoch file is valid
`check_subject()`	Complete validity check a RAVE subject
`check_subjects2()`	check subject validity tools
`check_subjects_old()`	check subject validity tools (use check_subjects2)
`create_local_cache()`	Create local cache to speed up loading speed
`customizedUI()`	Customized Shiny Elements
`decimate_fir()`	Decimate or Down-sample a Signal using `FIR` Filters
`define_initialization()`	Defines 'RAVE' Module Initialization Defines the global variables for the module. Called along with `define_input` to define UI initialization actions once a subject is loaded.
`define_input()`	Defines 'RAVE' Module Inputs
`define_output()`	Define 'RAVE' Module Output
`detect_modules()`	Check all packages to for new RAVE module packages
`diagnose_signal()`	Plot and Inspect Signals in Trace, Periodogram, and Histogram
`download_sample_data()`	Function to download demo data to data repository
`download_subject_data()`	Function to download subjects from internet/local
`electrode_localization()`	Electrode localization
`eval_when_ready()`	Add Function to run once Module is Ready
`export_diagnose_voltage()`	Export voltage (analog trace) diagnostic plots for each electrode
`fake_session()`	Fake 'shiny' Session for Debug Purpose
`finalize_installation()`	Finalize installation
`getDefaultDataRepository()`	Get environment where subject data is loaded
`getExecEnvirFromContext()`	Get Module Runtime Environment from Current Context
`getModuleEnvirFromContext()`	Get Module Instance from Current Context
`get_content()`	Parse 'RAVE' Module Contents
`get_dir()`	Get Directories in `RAVE`
`get_fake_updated_message()`	internally used for debugging functions
`get_mem_usage()`	Get RAM usage
`get_module()`	Function to find modules in packages
`get_path()`	Safe Way to Access Module Package Files Using Relative Path
`get_rave_theme`	Get RAVE Theme from Package Settings
`get_subjects()`	Get all subjects within project
`get_val()`	Get Value or Default
`import_electrodes()`	Import `.csv` files that contain electrode information
`init_app()`	Initialize main application for debugging purpose
`init_module()`	Initialize 'RAVE' module for debug purpose
`lapply_async()` `lapply_async3()`	`lapply` using future package in asynchronous way
`lazyarray_to_tensor()`	Convert 'LazyArray' instance to 'Tensor' instance
`load_local_cache()`	Load local cache for fast importing voltage, power, and phase
`load_meta()`	Load subject meta data
`load_modules()`	Load RAVE Modules
`load_rave_module_package()`	Function to load RAVE module package with UI tools
`load_scripts()`	Load scripts that cannot put into package R folder
`module_analysis_names()`	Find module analysis names
`mount_demo_subject()`	Load Demo Subject According to Package Configuration File
`notch_channel()`	Filter line noise out from ECoG channels
`notch_filter()`	Apply Notch Filter to Analog Trace Data
`plot_signals()`	Plot signals line by line
`progress()`	A wrapper for shiny Progress object
`pwelch()`	Plot "Welch" Periodogram
`r_to_py.Subject()`	Convert subject to python object
`cache()` `cache_input()` `clear_cache()`	Cache R Objects with Different levels
`close_tab()` `open_tab()`	Open/Close a tab in RAVE main application
`rave_brain2()`	Tools to load and view brain in 3D viewer
`rave_checks()`	Check if data is loaded for current module
`rave_context()`	'RAVE' Context: Read and Set Context of Environments
`rave_context_generics()`	Create S3 Generics that Respects 'RAVE' Context
`rave_failure()`	RAVE Failure Message
`rave_ignore()`	Functions for development use
`rave_import_rawdata()`	Import Raw Signal from Non-standard Formats
`rave_module_tools()`	Tools for module writers
`rave_options()`	Function to change rave-options
`rave_prepare()`	Load Subject and Create `iEEG/ECoG` Data Environment
`rave_preprocess()`	RAVE Preprocess Function
`rave_preprocess_tools()`	Function to create RAVE preprocess tools
`rave_version()`	Get RAVE version
`read_mgrid()`	Make `iElvis` `mgrid` file
`reload_module_package()`	Reload 'RAVE' module package without restarting 'RStudio'
`safe_write_csv()`	Save data to "CSV", if file exists, rename old file
`save_meta()`	Function to save meta data to subject
`save_options()`	Function to locally save options (deprecated)
`getDefaultReactiveInput()` `getDefaultReactiveOutput()`	Get `shiny' "input" and "output" objects under current context
`set_rave_theme()`	Set and Return RAVE theme
`shinirize()`	Convert module to objects used in shiny
`shiny_icons`	Shiny icons
`start_rave()`	Start RAVE main application
`subject_tmpfile()`	Create temp file in subject module folder
`suma_spec_parse()`	Parse `SUMA` `spec` file
`suma_surface_volume_parse()`	Parse `AFNI` `BRIK/HEAD` file
`to_module()`	Parse 'RAVE' Module and Returns Parsed Content in Environments
`view_layout()`	Debug-use only, reload package, mount demo subject, and launch shiny app
`wavelet()`	Wavelet Transformation With Phase
`wavelet_kernels()`	Returns wavelets to be used for wavelet function

Reference

All functions