Learn R Programming

ravecore

The goal of ravecore is to provide storage infrastructure to read, process, and analyze intracranial electroencephalography and deep-brain stimulation in RAVE, a reproducible framework for analysis and visualization framework. This package supports BIDS or native file conventions to ingest signals in HDF5, Matlab, EDF, BrainVision, or BlackRock formats. For images, this package process images in NIfTI and FreeSurfer formats, providing brain imaging normalization to template brain, facilitate comprehensive electrode localization and 3D brain visualization. Other RAVE packages include:

  • ravetools - signal and imaging tools
  • ravepipeline - running pipelines and interactive modules
  • ravedash - front-end user interface

See our official website for tutorials and documentations:

To cite the package and 3D viewer in general

  • Magnotti, J. F., Wang, Z., & Beauchamp, M. S. (2020). RAVE: Comprehensive open-source software for reproducible analysis and visualization of intracranial EEG data. NeuroImage, 223, 117341.

If you use RAVE/YAEL for localization or brain normalization, cite

  • Wang, Z., Magnotti, J. F., Zhang, X., & Beauchamp, M. S. (2023). YAEL: Your Advanced Electrode Localizer. Eneuro, 10(10).

Installation

Please check https://rave.wiki/posts/installation/installation.html for full installation guide.

For advanced developers, you can install the development version of ravecore with:

# install.packages("pak")
pak::pak("rave-ieeg/ravecore")

Copy Link

Version

Install

install.packages('ravecore')

Monthly Downloads

248

Version

0.1.0

License

MIT + file LICENSE

Maintainer

Zhengjia Wang

Last Published

September 23rd, 2025

Functions in ravecore (0.1.0)

RAVEAbstarctElectrode

Abstract definition of electrode class in 'RAVE'
LFP_reference

Definitions of reference with local field potential signal type
RAVEProject

Definition for 'RAVE' project class
RAVESubject

Defines 'RAVE' subject class
LFP_electrode

Definitions of electrode with local field potential signal type
RAVESubjectEpochPhaseRepository

'RAVE' class for epoch repository - time-frequency phase
RAVESubjectBaseRepository

'RAVE' class for base repository
Auxiliary_electrode

Class definition for auxiliary channels
RAVEEpoch

Definition for epoch class
RAVEPreprocessSettings

Defines preprocess configurations
RAVESubjectRecordingBlockRawVoltageRepository

'RAVE' class for blocks of voltage repository
RAVESubjectEpochVoltageRepository

'RAVE' class for epoch repository - voltage
RAVESubjectEpochTimeFreqCoefRepository

'RAVE' class for epoch repository - time-frequency
RAVESubjectEpochRepository

'RAVE' class for epoch repository
RAVESubjectEpochTimeFreqBaseRepository

'RAVE' class for epoch repository - time-frequency (internal)
RAVESubjectRecordingBlockPowerRepository

'RAVE' class for loading time-frequency power components
RAVESubjectEpochRawVoltageRepository

'RAVE' class for epoch repository - raw voltage
RAVESubjectRecordingBlockPhaseRepository

'RAVE' class for loading time-frequency phase components
RAVESubjectEpochPowerRepository

'RAVE' class for epoch repository - time-frequency power
RAVESubjectRecordingBlockRepository

'RAVE' class for loading entire recording block repository
cache_path

Manipulate cached data on the file systems
backup_file

Back up and rename the file or directory
archive_subject

Archive and share a subject
as_rave_project

Convert character to RAVEProject instance
YAELProcess

Class definition of 'YAEL' image pipeline
as_yael_process

Create a 'YAEL' imaging processing instance
Spike_electrode

Class definition for micro-wire spike channels
RAVESubjectRecordingBlockVoltageRepository

'RAVE' class for blocks of voltage repository
RAVESubjectRecordingBlockTimeFreqCoefRepository

'RAVE' class for loading time-frequency coefficients
RAVESubjectRecordingBlockTimeFreqBaseRepository

'RAVE' class for loading entire block of time-frequency coefficients
cmd_run_ants_coreg

Register a computerized tomography (CT) image to MRI via 'ANTs'
cmd-external

External shell commands for 'RAVE'
compose_channel

Compose a phantom channel from existing electrodes
cmd_run_dcm2niix

Convert DICOM to NIfTI via 'dcm2niix'
collapse2

Collapse high-dimensional tensor array
cmd_run_freesurfer_recon_all

Workflow: 'FreeSurfer' surface reconstruction
collapse_power

Collapse power array with given analysis cubes
cmd_run_yael_preprocess

Run a built-in 'YAEL' imaging processing workflow
cmd_run_3dAllineate

Align images using 'AFNI'
cmd_run_fsl_flirt

Run 'FSL' linear registration
export_table

Export data frame to different common formats
glimpse-repository

Visualizes repositories with interactive plots
new_electrode

Create new electrode channel instance or a reference signal instance
convert_electrode_table_to_bids

Convert electrode table
get_projects

Get all possible projects in 'RAVE' default directory
generate_reference

Generate common average reference signal for 'RAVE' subjects
install_openneuro

Install data-sets from OpenNeuro
import-signals

Import signal data into 'RAVE'
meta-data

Load or save meta data to 'RAVE' subject
install_subject

Install a subject from the internet, a zip file or a directory
prepare_subject_with_epochs

'RAVE' repository: with epochs
prepare_subject_with_blocks

'RAVE' repository: with entire recording blocks
prepare_subject_bare

'RAVE' repository: basic
rave_cmd_tools

Find external command-line tools
niftyreg_coreg

Register a computerized tomography (CT) image to MRI via 'NiftyReg'
rave_brain

Load 'FreeSurfer' brain from 'RAVE'
new_rave_subject

Get RAVESubject instance from character
power_baseline

Calculate power baseline
py_nipy_coreg

Register a computerized tomography (CT) image to MRI via 'nipy'
plot_volume_slices

Plot volume slices into scalable vector graphics SVG images
validate_subject

Validate subject data integrity
ravecore-package

ravecore: Core File Structures and Workflows for 'RAVE'
validate_time_window

Validate time windows to be used
rave_legacy_subject_format_conversion

Legacy support for 'RAVE' 1.0 format
run_wavelet

Apply Morlet-Wavelet to subject
transform_point_to_template

Calculate template 'MNI' coordinates for points on native brain
rave_path

Find file paths based on storage
ravecore-constants

'RAVE' constants