R: Class "DependencyModel"

DependencyModel-class {dmt} | R Documentation

## Class "DependencyModel"

### Description

A Dependency model for one or two data sets

### Objects from the Class

Returned by `fit.dependency.model`, `ppca`, `pfa`, and `pcca` functions.

### Slots

W

  a list of X, Y and total components containing the relationship between two data sets; for dependency model for one dataset, only total is given

phi

  a list of X, Y and total components containing the data set specific covariances; for dependency model for one dataset, only total is given

score

  score for fitness of model

method

  name of the used method

params

  list of parameters used in dependency model

data

  The data used to calculate the dependency model

z

  The latent variable Z

### Methods

getW

  `signature(model = "DependencyModel")`: Returns a list of model variable `W`s `X`, `Y` and `total` component

getPhi

  `signature(model = "DependencyModel")`: Returns a list of model variable `phi`s `X` and `Y` and `total` component

getScore

  `signature(model = "DependencyModel")`: Returns the dependency score of model

getParams

  `signature(model = "DependencyModel")`: Returns a list of used parameters for the method

getModelMethod

  `signature(model = "DependencyModel")`: Returns the name of the used method

getWindowSize

  `signature(model = "DependencyModel")`: Returns the size of window

getZ

  `signature(model = "DependencyModel", X = "numeric", Y = "numeric")`: Returns the latent variable z. Arguments `X` and `Y` are needed only when the dependency model is calculated without calculating the latent variable and the original data is not included with the model (arguments `calculateZ = FALSE` and `includeData = FALSE` in `fit.dependency.model`.

### Author(s)

Olli-Pekka Huovilainen ohuovila@gmail.com

### Examples

    data(modelData) # Load example data X, Y
    model <- fit.dependency.model(X, Y)
    # Getting the latent variable Z when it has been calculated with the model
    #getZ(model)

[Package dmt version 0.8.20 Index]