rhythm: Rhythm of events

In asshah4/outcomes: Cyclical and rhythm-based statistics

Rhythm of events

Description

The type of data that internally helps to parse data will be built and validated on this class definition. This allos for understanding of the type of variable (continuous or categorical) and how it is sampled (regular or irregular intervals).

Usage

rhythm(x, t, f, a, ...)

Arguments

x	Vector of potential data points that reflect (or do not reflect) event data
t	Vector of time points that reflect information about events
f	Frequency of data sampling to help udnerstand the range and scale of t, such as if its in calendar years, time stamps, or continuous time intervals.
a	Annotation that labels certain points as of having particular interest, such as event status, censorship, etc.

Details

Both x and t must be vectors of the same length. a is presumed to be only annotation data at certain positions. f serves as a marker of frequency or scale of the data (e.g. if its in days, years, months, or a smaller, more continuous scale such as seconds, minutes, etc).

Value

A "combined" record of the rhythm class that has validated event and time properties.

asshah4/outcomes documentation built on April 5, 2024, 11:56 p.m.