RAVE:Install

From OpenWetWare
Jump to navigationJump to search
RAVE logo R Analysis and Visualization of iEEG

RAVE


Pre-compiled Installation (Recommended)

1. Install the prerequisites. The most common installation problem is that the prerequisites are not installed.

2. Open the RStudio application if it is not already open. Copy and paste the following command into the "Console" tab of the RStudio application:

 options(repos = c(ropensci = 'https://beauchamplab.r-universe.dev', CRAN = 'https://cloud.r-project.org'))

Next, copy and paste the following command into the "Console" tab:

 install.packages(c('rave', 'ravebuiltins'))

If you are asked "Do you want to install from sources the package which needs compilation? (Yes/no/cancel)", answer "no". If you are asked "These packages have more recent versions available. It is recommended to update all of them. Which would you like to update?" answer "2: CRAN packages only".

3. Copy and paste the following command into the "Console" tab of the RStudio application:

 rave::check_dependencies(nightly = TRUE)

This downloads and compiles some internal configuration files.

4. Copy and paste the following command into the "Console" tab of the RStudio application:

 rave::finalize_installation(upgrade = 'ask')

This finalizes installations and installs demo data. Downloading the demo data may take a few minutes depending on the speed of your internet connection. To check on progress, click on the "Jobs" tab. When a single job finishes, click the small left blue arrow in the top left to see the screen with all jobs. When all downloads are shown as complete, check the installation (next step, below).

Checking installation

After installing or updating RAVE, quit and restart RStudio before continuing. Copy and paste the following command into the "Console" tab of the RStudio application:

 rave::start_rave()

A new web browser window should open showing the RAVE splash screen and the current version number (e.g. 1.0). If RAVE data is not in the default location, copy and paste the following command into the "Console" tab of the RStudio application:

rave::rave_options()

This will allow you to set the data directory to the correct location.

Updating RAVE

To update existing installations of RAVE, first check for newer versions of RStudio (start RStudio, "Help"/"Check for Updates") and R (start R, "R"/"Check For R Updates"). Enter this command into the RStudio console:

 rave::check_dependencies(nightly = TRUE)

After this command completes, quit and restart RStudio. Then restart your brand new RAVE:

 rave::start_rave()

If this fails, the fallback is to completely reinstall RAVE (start from the top of this page).

Uninstalling RAVE

There are no circumstances under which you would ever need to uninstall RAVE. Perhaps you are giving your computer to an enemy and do not wish them to enjoy the non-stop lovefest that is RAVE? In this case, enter the following command in RStudio:

 source("https://raw.githubusercontent.com/beauchamplab/rave/master/uninstall.R")

Other Methods To Install RAVE

Docker (special-purpose containerized installation)

Docker creates a "virtual machine" within which other software, such as RAVE, runs. This can be useful if you wish to distribute or create archival copies of RAVE, for instance to create a snapshot of software+data for uploading to a repository when a manuscript is published.For more information, see the GitHub Rave Docker page.

RAVE-within-Docker is not recommended for day-to-day (production) usage as performance is worse and usage is more complex. For most use case, we recommend installing RAVE using the steps above.

Even more methods for installing RAVE.


What's Next