HRTList {RHRT} | R Documentation |
S4 class to represent a list of HRT objects
Description
This class specifies an object to save all HRT objects of a given vector. It also saves an averaged HRT for calculation of the averaged HRT parameters and plotting of all HRTs in a single plot.
Usage
## S4 method for signature 'HRTList'
initialize(
.Object,
name = NA_character_,
IL = NA_real_,
pos = NA_real_,
HRTs = list(),
avHRT = new("avHRT"),
RMSSD = NA_real_
)
Arguments
.Object |
(Character) The name of the class |
name |
(Character) Name of the vector if given |
IL |
(Numeric) Arithmetic mean of the overall interval length of the vector |
pos |
(Numeric vector) Positions of premature ventricular complexes in given input |
HRTs |
(List) All HRT objects |
avHRT |
(avHRT object) The average of all HRTs |
RMSSD |
(Numeric) Square root of the mean of the squared successive differences between adjacent intervals of the whole measurement |
Value
(HRTList) A new HRTList object
Slots
name
(Character) Name of the vector if given
IL
(Numeric) Arithmetic mean of the overall interval length of the vector
pos
(Numeric vector) Positions of premature ventricular complexes in given input
HRTs
(List) All HRT objects
avHRT
(avHRT object) The average of all HRTs
RMSSD
(Numeric) Square root of the mean of the squared successive differences between adjacent intervals of the whole measurement
Note
After using vectorToHRT
all slots in the resulting HRTList
object are set. Please do not set them manually since many functions of the
HRTList class rely on valid values assigned to the needed slots.