dipterix / rave

R Analysis and Visualization of ECOG Data

RAVE

R Analysis and Visualization of intracranial Electroencephalography

Installation

• RAVE requires the installation of the language "R" and other miscellaneous programming tools, including "RStudio". Please click here for the prerequisite installation guide to install all needed tools for your operating system.

• RAVE runs best on modern computers with multicore CPUs, click here for suggested system configurations.

• After the prerequisites are installed, open R-Studio (in Mac OSX, Rstudio icon is installed in your Applications folder). Copy and paste the following commands into the RStudio console to download the current version of RAVE. The commands must be typed one at a time. If packages need to be installed, you may accept the defaults by typing "Yes" to any questions that appear. In the case of errors, relaunch RStudio and repeat the commands or try the alternative installation command.

# Install RAVE and builtin modules
install.packages('devtools')
devtools::install_github('dipterix/threeBrain')
devtools::install_github('dipterix/rutabaga')
devtools::install_github('beauchamplab/ravebuiltins')
devtools::install_github('beauchamplab/[email protected]')

Alternative installation command:

install.packages('pak')
pak::pkg_install('dipterix/threeBrain')
pak::pkg_install('dipterix/rutabaga')
pak::pkg_install('beauchamplab/ravebuiltins')
pak::pkg_install('beauchamplab/[email protected]')

• After installing or updating RAVE, quit and restart RStudio before continuing.

Download Demo Data

• If you do not have any data in RAVE format, we recommend you download some sample data. Copy and paste the following commands into the RStudio console:

# load RAVE functions 
library(rave)
# download a demo subject ~ 400MB of data
download_subject_data('https://s3-us-west-2.amazonaws.com/rave-demo-subject/sfn-demo/data-large.zip')

Once you see the folowing message, the subject is downloaded. The directory (XXX) will vary depending on the machine.

[ INFO ]: Expanding zip file
[ INFO ]: Copy from tempdir to data repository
[ INFO ]: Clean up
[ INFO ]: Done. Subject [sub1] is now at 
[Raw Data]: /XXX/rave_data/raw_dir/sub1
[RAVE Data]: /XXX/rave_data/raw_dir/demo

Start RAVE

• To start RAVE, copy and paste the following commands into the RStudio console:

# Launch main app
rave::start_rave()

Using Rave

• For tutorials on how to use RAVE, click here

• To preprocess data, copy and paste the following commands into the RStudio console:

# Preprocess
rave::rave_preprocess()