getTimePoints

getData

getSummarizedData

getNPeriods

getFittedValues

getM

getA

getAlpha

getBeta

getOmega

getSSE

getR2

getNIter

A collection of functions to extract slots from S4 objects of class <code>'FMM'</code>.
 
The extractor functions are:
<table class="table">
<tr><td>
 <code>getTimePoints</code></td><td>Extracts the timePoints slot from a S4 object of class <code>'FMM'</code>.</td></tr>
<tr><td><code>getData</code></td><td>Extracts the data slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getSummarizedData</code></td><td>Extracts the summarizedData slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getNPeriods</code></td><td>Extracts the nPeriods slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getFittedValues</code></td><td>Extracts the fittedValues slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getM</code></td><td>Extracts the M slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getA</code></td><td>Extracts the A slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getAlpha</code></td><td>Extracts the alpha slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getBeta</code></td><td>Extracts the beta slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getOmega</code></td><td>Extracts the omega slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getSSE</code></td><td>Extracts the SSE slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getR2</code></td><td>Extracts the R2 slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getNIter</code></td><td>Extracts the nIter slot from a S4 object of class <code>'FMM'</code>,</td></tr>
</table>

getS4

Provides a collection of functions to fit and explore single, multi-component and restricted Frequency Modulated Moebius (FMM) models. 'FMM' is a nonlinear parametric regression model capable of fitting non-sinusoidal shapes in rhythmic patterns. Details about the mathematical formulation of 'FMM' models can be found in Rueda et al. (2019) <doi:10.1038/s41598-019-54569-1>.

Itziar Fernandez

Rhythmic Patterns Modeling by FMM Models

Yolanda Larriba

Christian Canedo

Alejandro Rodriguez-Collado

Adrian Lamela

Cristina Rueda

getS4 function

<dl> <dt>objFMM</dt>
<dd>an object of class of class <code>'FMM'</code>.</dd></dl>

Arguments

A collection of functions to extract slots from S4 objects of class <code>'FMM'</code>.
 
The extractor functions are:
<table class='table'>
<tr><td>
 <code>getTimePoints</code></td><td>Extracts the timePoints slot from a S4 object of class <code>'FMM'</code>.</td></tr>
<tr><td><code>getData</code></td><td>Extracts the data slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getSummarizedData</code></td><td>Extracts the summarizedData slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getNPeriods</code></td><td>Extracts the nPeriods slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getFittedValues</code></td><td>Extracts the fittedValues slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getM</code></td><td>Extracts the M slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getA</code></td><td>Extracts the A slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getAlpha</code></td><td>Extracts the alpha slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getBeta</code></td><td>Extracts the beta slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getOmega</code></td><td>Extracts the omega slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getSSE</code></td><td>Extracts the SSE slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getR2</code></td><td>Extracts the R2 slot from a S4 object of class <code>'FMM'</code>,</td></tr>
<tr><td><code>getNIter</code></td><td>Extracts the nIter slot from a S4 object of class <code>'FMM'</code>,</td></tr>
</table>

General S4 Class Extractor Functions — getS4

<dl>

 <dt>objFMM</dt>
<dd>an object of class of class <code>'FMM'</code>.</dd>

</dl>

General S4 Class Extractor Functions

`getTimePoints`	Extracts the timePoints slot from a S4 object of class `'FMM'`.
`getData`	Extracts the data slot from a S4 object of class `'FMM'`,
`getSummarizedData`	Extracts the summarizedData slot from a S4 object of class `'FMM'`,
`getNPeriods`	Extracts the nPeriods slot from a S4 object of class `'FMM'`,
`getFittedValues`	Extracts the fittedValues slot from a S4 object of class `'FMM'`,
`getM`	Extracts the M slot from a S4 object of class `'FMM'`,
`getA`	Extracts the A slot from a S4 object of class `'FMM'`,
`getAlpha`	Extracts the alpha slot from a S4 object of class `'FMM'`,
`getBeta`	Extracts the beta slot from a S4 object of class `'FMM'`,
`getOmega`	Extracts the omega slot from a S4 object of class `'FMM'`,
`getSSE`	Extracts the SSE slot from a S4 object of class `'FMM'`,
`getR2`	Extracts the R2 slot from a S4 object of class `'FMM'`,
`getNIter`	Extracts the nIter slot from a S4 object of class `'FMM'`,

Data Engineering and BI courses are free this week!

getS4: General S4 Class Extractor Functions

Description

Usage

Value

Arguments