experiment-class {arf3DS4} | R Documentation

## arf3DS4 "experiment" class

### Description

The "experiment" class is the backbone of the arf3DS4 package. The class contains information on the names of all relevant directories and files (these are inherited from an "settings" object (see `settings`)). Before running an ARF analysis an object of class "experiment" must be loaded (using `loadExp`). Experiment directories can be created using `makeExpDirs`. To view information on an experiment call `getExp`.

### Objects from the Class

Objects can be created by calls of the form `new("experiment", ...)`.

### Slots

`path`:

  Path of the experiment.

`name`:

  Name of the experiment.

`subject.num`:

  Number of subjects.

`subject.names`:

  Vector of `length(subject.num)` containing subject names.

`condition.num`:

  Number of conditions.

`condition.names`:

  Vector of `length(condition.num)` containing condition names.

`expRda`:

  Name of the .Rda file containing the experiment information.

`optionsRda`:

  Name of the .Rda file containing the options for fitting an ARF model.

`startRda`:

  Name of the .Rda file containing the startingvalues for fitting an ARF model.

`dataRda`:

  Name of the .Rda file containing the fMRI data location and information.

`modelRda`:

  Name of the .Rda file containing the ARF model information.

`statsRda`:

  Name of the .Rda file containing the statistics information of a model (not yet implemented).

`regRda`:

  Name of the .Rda file containing the registration information of an fMRI data image.

`funcRda`:

  Name of the .Rda file containing the functional information of an fMRI data image.

`subjectPrefix`:

  Prefix for the subject names. Defaults to empty.

`conditionPrefix`:

  Prefix for the condition names. Defaults to empty.

`modelPrefix`:

  Prefix for the model names. Defaults to empty.

`subjectDir`:

  Name of the subjects directory.

`conditionDir`:

  Name of the conditions directory.

`dataDir`:

  Name of the data directory.

`weightsDir`:

  Name of the weights directory (within conditions/data).

`avgDir`:

  Name of the average data directory (within conditions/data).

`regDir`:

  Name of the registration directory (within conditions/data).

`funcDir`:

  Name of the functional directories (within subjects and conditions/data).

`betaDir`:

  Name of the beta directory (within conditions/data).

`modelDir`:

  Name of the model directory.

`statsDir`:

  Name of the stats directory (not yet implemented).

`modeldatDir`:

  Name of the data directory (within models).

`avgdatFile`:

  Name of the averaged data file (fMRI).

`avgWFile`:

  Name of the averaged weight file (fMRI).

`avgtstatFile`:

  Name of the averaged t-values file (fMRI).

`modelDataFile`:

  Name of the model prediction file (fMRI).

`modelnamesRda`:

  Name of the modelnames.Rda file containing the fitted models.

`residualFile`:

  Name of the residuals file (binary).

`derivativeFile`:

  Name of the derivatives file (binary).

`weightFile`:

  Name of the weight file (binary).

`lowresFile`:

  Name of the low resolution structural image.

`lowresAvg`:

  Name of the average low resolution structural image.

`logFile`:

  Name of the logFile (not yet implemented).

`version`:

  Object of class "version" (see `version`)

### Extends

Class `"settings"`, directly.

### Methods

Standard arf3DS4 accessor and replacement functions can be used to access and replace slots.

access

  `.classname.slotname(object)`

replace

  `.classname.slotname(object)<-`

In this case classname is "experiment" and slotname is for example "avgdatfile". So to access the "avgdatfile" slot of an r-object "myexperiment" (of class "experiment") type `.experiment.avgdatfile(myexperiment)`.

### Author(s)

Wouter D. Weeda - w.d.weeda@gmail.com

### See Also

`settings`, `makeExpDirs`, `loadExp`, `getExp`

### Examples

    showClass("experiment")

[Package arf3DS4 version 2.5-10 Index]