GenerateEpisodes: Creates new episodes from old ones

View source: R/GenerateEpisodes.R

GenerateEpisodesR Documentation

Creates new episodes from old ones

Description

Creates new episodes, or annotated physiological events, from existing ones and stores them into the data structure containing the beat positions

Usage

GenerateEpisodes(HRVData, NewBegFrom, NewEndFrom, DispBeg, DispEnd, 
		OldTag = "", NewTag = "", verbose=NULL)

Arguments

HRVData

Data structure that stores the beats register and information related to it

NewBegFrom

Source of new beginning of episodes ("Beg" for indicating the beginning as the beginning of the old episode, "End" for end)

NewEndFrom

Source of new end of episodes ("Beg" for indicating the end as the beginning of the old episode, "End" for end)

DispBeg

Absolute displacement from the beginning for new episodes in seconds

DispEnd

Absolute displacement from the end for new episodes in seconds

OldTag

Tag of old episodes

NewTag

Tag for new episodes (if empty, copies OldTag)

verbose

Deprecated argument maintained for compatibility, use SetVerbose() instead

Value

Returns HRVData, the structure that contains beat positions register and new episodes information

Note

##Example of arguments for creating episodes displaced one
minute before old ones:
##NewBegFrom = "Beg", NewEndFrom = "End", DispBeg = -60,
DispEnd = -60
##Example of arguments for creating episodes just after previous
ones of 1 minute length:
##NewBegFrom = "End", NewEndFrom = "End", DispBeg = 0,
DispEnd = 60

Author(s)

M. Lado, A. Mendez, D. Olivieri, L. Rodriguez, X. Vila

References

L. Rodriguez-Linares, A. Mendez, M. Lado, D. Olivieri, X. Vila, I. Gomez-Conde, "An open source tool for heart rate variability spectral analysis", Computer Methods and Programs in Biomedicine 103, 39-50, doi:10.1016/j.cmpb.2010.05.012 (2011)


RHRV documentation built on Nov. 1, 2022, 1:05 a.m.