RAVE:RAVEGUI Help

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

Getting Help

Clicking on the help icon in each RAVE menu ("?") opens a help page, also accessible from the tabs above. Help is searchable e.g. to find help on outliers in RAVE search for outlier in openwetware.org/wiki/RAVE in Google. Personalized support is provided via our Slack workspace rave-brain.slack.com. E-mail rave-support@listserv.bcm.edu for an invitation to the support channel.

Launching RAVE

Installing RAVE may create a desktop RAVE shortcut. If so, double-click the icon to launch RAVE. Otherwise, open RStudio and enter the following command into the console:

 rave::start_rave()

A new web browser window should open with the RAVE splash screen. In the RAVE Toolbar (shown below) click on Select Data to explore the provided demo data. To load your own data, follow these steps.

Shutting down RAVE

Closing the browser window does not affect the RAVE server. To stop the server:

  1. If you launched RAVE by double-clicking a desktop shortcut, close the terminal window.
  2. If you launched RAVE from RStudio, click the red "stop sign" icon in the RStudio window. In RStudio, select "RStudio"/"Quit RStudio". You will be asked "Save workspace image?". Click "Don't Save". To disable asking, select "RStudio"/"Preferences". In the "General" Tab, change "Save Workspace to .Rdata on exit" to "Never".

Shutting down the server will freeze the browser window and it may be closed.

RAVE Toolbar

The RAVE toolbar contains input panels on the left ("Configure Analysis") and output panels on the right ("Results on Surface"). Click on a tab at the top of this page (e.g. "Power Explorer") for more information. RAVE toolbar and panels

Advanced: Launch RAVE in server mode

To launch a RAVE server, enter the following command on the server machine:

rave::start_rave(host = 'Server_IP_Address', launch.browser=FALSE, port = 1111)

Port numbers 0-1023 are reserved and should not be used but any other port value should be fine. Client computers on the local network can interact with the RAVE server using a web browser:

http://Server_IP_Address:1111

where Server_IP_Address and 1111 match the server values above. A server can host multiple RAVE instances by opening a new RStudio session ("Session"/"New Session") and launching RAVE with a different port number.

How to use RAVE on the BeauchampLab MacPro

Older notes