model-class {arf3DS4} | R Documentation

## arf3DS4 "model" class

### Description

The arf3DS4 model class contains all information on a (fitted) model. It extends the "data" class directly, since it uses the files specified there to fit the model. The "model" class contains information on file locations and filenames. More importantly it contains information on the fitted model: parameter estimates, parameter (co)variance matrix, statistical test information, fit indices, convergence information, warnings, etc.

### Objects

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

### Slots

`modelname`:

  Name of the (fitted) model.

`modelpath`:

  Full path to the model directory.

`modeldatapath`:

  Full path to the model/data directory.

`residualFile`:

  Name of the file containing model residuals.

`derivativeFile`:

  Name of the file containing first order derivatives.

`weightFile`:

  Name of the binary file containing weights.

`modelDataFile`:

  Name of the file containing model predictions.

`fullmodelDataFile`:

  Full name of the file containing model predictions.

`modelFile`:

  Name of the model.Rda file containing the model object.

`optionsFile`:

  Name of the options.Rda file (used to specify options, see `options`).

`startFile`:

  Name of the start.Rda file.

`logFile`:

  Name of the log.Rda file.

`convergence`:

  Convergence information.

`iterates`:

  Number of iterates.

`minimum`:

  Value of the objective function at the minimum.

`estimates`:

  Parameter Estimates.

`gradient`:

  Gradient of the parameters at the minimum.

`hessian`:

  Hessian matrix of parameters.

`params`:

  Number of parameters.

`modeltype`:

  Type of model fitted.

`sandwichmethod`:

  Method used to calculate Sandwich estimates.

`varcov`:

  Variance/covariance matrix of the parameters.

`warnings`:

  Warnings encountered during processing.

`fit`:

  Fit of the model (BIC and RMSEA).

`wald`:

  Wald class object (containing model statistics, see `wald`).

`regions`:

  Number of regions in the spatial model.

`startval`:

  Starting values of the minimization procedure.

`proctime`:

  Processing time of minimization and sandwich procedures.

`valid`:

  Is the model valid?

`name`:

  Name of the data object, usually 'subjectname - conditionname'.

`fullpath`:

  Full path to the data directory.

`betafiles`:

  Vector of filenames (full paths) of the beta files (containing beta estimates).

`weightfiles`:

  Vector of filenames (full paths) of the weight files (containing variances of the beta estimates).

`avgdatfile`:

  Filename of the averaged beta file.

`avgWfile`:

  Filename of the averaged weight file.

`avgtstatFile`:

  Filename of the average t-statistics (=avgbetafile/sqrt(avgweightfile)) file.

`n`:

  Number of 'brain' voxels (i.e. the number of voxels excluding those where `@mask` is zero).

`mask`:

  Vector containing the mask for the data.

`ss`:

  Sums-of-squares of the data.

`regDir`:

  Fullpath to the registration directory.

`regRda`:

  Name of the registration.Rda file.

`funcDir`:

  Fullpath to the functional directory.

`funcRda`:

  Name of the functional.Rda file.

`dataHeader`:

  Nifti header information from the avgdataFile.

`runs`:

  Number of runs (= number of beta files).

`version`:

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

### Extends

Class `data`, directly.

### Methods

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

access

  `.classname.slotname(object)`

replace

  `.classname.slotname(object)<-`

plot

  `signature(x = "model", y = "missing")`: ...

show

  `signature(object = "model")`: ...

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

### Author(s)

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

### See Also

`data`, `options`, `wald`

### Examples

    showClass("model")

[Package arf3DS4 version 2.5-10 Index]