Class function

FMM Class Representation

FMM Class Representation

Class representation for an S4 object of class 'FMM'.

Returns

The S4 object of class 'FMM' contains the following slots:

  • @timePoints: The time points as specified by the input argument. It is a numeric vector containing the time points at which each data of one single period is observed.

  • @data: The data as specified by the input argument. It is a numeric vector containing the data to be fitted a FMM model. Data could be collected over multiple periods.

  • @summarizedData: When the data has more than one period, a numeric vector containing data averaging the data at each time point across all considered periods.

  • @nPeriods: A numeric value containing the number of periods in data as specified by the input argument.

  • @fittedValues: A numeric vector of the fitted values by the FMM model.

  • @M: A numeric value of the estimated intercept parameter MM.

  • @A: A numeric value or vector of the estimated FMM wave amplitude parameter(s) AA.

  • @alpha: A numeric value or vector of the estimated FMM wave phase translation parameter(s) α\alpha.

  • @beta: A numeric value or vector of the estimated FMM wave skewness parameter(s) β\beta.

  • @omega: A numeric value or vector of the estimated FMM wave kurtosis parameter(s) ω\omega.

  • @SSE: A numeric value of the sum of the residual squares values.

  • @R2: A numeric vector specifying the explained variance by each of the fitted FMM components.

  • @nIter: A numeric value specifying the number of iterations of the fitting algorithm.

Examples

## FMM class getClass("FMM") getSlots("FMM")
  • Maintainer: Itziar Fernandez
  • License: GPL (>= 2)
  • Last published: 2025-04-18