Class: FMM Class Representation

Description Value Examples

Description

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

Value

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 M.

@A

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

@alpha

A numeric value or vector of the estimated FMM wave phase translation parameter(s) α.

@beta

A numeric value or vector of the estimated FMM wave skewness parameter(s) β.

@omega

A numeric value or vector of the estimated FMM wave kurtosis parameter(s) ω.

@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

1
2
3
## FMM class
getClass("FMM")
getSlots("FMM")

FMM documentation built on Dec. 17, 2021, 5:06 p.m.