Getting Started

If you are new to RRest it is recommended that you follow these steps to gain familiarity with the toolbox. These steps are demonstrated in this video.

Download a sample dataset

Several datasets are compatible with the toolbox (as listed here). Of these, the Synthetic Dataset, named 'RRSYNTH', is perhaps the easiest one to start with. Instructions on how to obtain the dataset are available here.

Amend the Universal Parameters

The Universal Parameters are a set of parameters which are used throughout the toolbox. In particular, the File Paths must be set for your own computer as detailed here. Apart from these, all other parameters can be left alone to get started.

Run your first analysis

RRest is the main script which runs the analysis. It takes a single input specifying the dataset to be analysed, such as the 'RRSYNTH' dataset. Use a command such as this to run RRest:

RRest('RRSYNTH')