ResultSet-class {Cardinal} | R Documentation

## ResultSet: Class to contain analysis results for imaging experiments

### Description

This class is used as a return value by most of the analysis methods provided by Cardinal, including `PCA`, `PLS`, `OPLS`, `spatialKMeans`, `spatialShrunkenCentroids`.

### Slots

`imageData`:

  This slot is unused in a `ResultSet`.

`pixelData`:

  The `pixelData` from the analyzed dataset.

`featureData`:

  The `featureData` from the analyzed dataset.

`experimentData`:

  The `experimentData` from the analyzed dataset.

`protocolData`:

  The `protocolData` from the analyzed dataset.

`resultData`:

  A `list` of analysis results. Each element contains the results from a different parameter set.

`modelData`:

  An `AnnotatedDataFrame` containing information about the parameters of the models in `resultData`.

`.__classVersion__`:

  A `Versions` object describing the version of the class used to created the instance. Intended for developer use.

### Extends

`iSet`, directly. `VersionedBiobase`, by class "iSet", distance 1. `Versioned`, by class "VersionedBiobase", distance 2.

### Creating Objects

`ResultSet` is a virtual class. No instances can be created.

### Methods

Class-specific methods:

`resultData(object)`:

  Access and set the results of the analyses.

`modelData(object)`:

  Access and set the model parameters.

Standard generic methods:

`length(x)`:

  Access the number of elements of `resultData`.

`names(x)`:

  Access the names of the components of all of the elements of `resultData`.

`ResultSet$name`:

  Access all of the result components with the name `name`.

`ResultSet[[i, ...]]`:

  Access `i`th element of the `resultData` slot.

`ResultSet[i, j, ..., drop]`:

  Subset an `ResultSet` based on the model parameters in `modelData`.

See `iSet` for additional methods.

### Author(s)

Kylie A. Bemis

### See Also

`iSet`, `PCA`, `PLS`, `OPLS`, `spatialKMeans`, `spatialShrunkenCentroids`

[Package Cardinal version 2.4.0 Index]