settings_template_hrv: Template for analysis settings.

Description Usage Value Analysis options Segment settings Time domain settings Frequency domain settings Standard frequency bands Custom frequency bands General spectrum parameters Geometric settings Nonlinear settings

Description

Return a list of lists, containing default analysis settings.

Usage

1

Value

A list with default analysis settings.

Analysis options

$analysis$time

Perform time-domain analyses. Default is TRUE.

$analysis$frequency

Perform frequency-domain analyses. Default is TRUE.

$analysis$geometric

Perform geometric analyses. Default is TRUE.

$analysis$nonlinear

Perform nonlinear analyses. Default is TRUE.

Segment settings

$segment.length

Segment length in seconds. Default is 300

$segment.overlap

Segment overlap in seconds. Default is 0

Time domain settings

$timedomain$metric.list

A list of the time domain HRV metrics that should be analyzed. The default is c("mean", "meanhr", "rmssd", "var", "stdev", "pnnx")

$timedomain$parameters$pnnx

A list indicating which pNNx values should be analysed. The default is c(50), so that the pNN50 is analyzed.

Frequency domain settings

$frequencydomain$metric.list

A list of the frequency domain metrics that should be analyzed. The default is c("standard") and if some custom bands are added, this must be set to c("standard", "custom").

Standard frequency bands

$frequencydomain$parameters$band.names.standard.prefix

String used to prefix the standard VLF, LF and HF bands. Default is c("")

$frequencydomain$parameters$band.vlf

VLF band limits. Default is c(0.00, 0.04)

$frequencydomain$parameters$band.lf

LF band limits. Default is c(0.04, 0.15)

$frequencydomain$parameters$band.hf

HF band limits. Default is c(0.15, 0.40)

Custom frequency bands

$frequencydomain$parameters$band.names.custom

A list of names with the custom frequency bands. E.g. c("custom1", "custom2")

$frequencydomain$parameters$band.lower

Lower limits for the custom frequency bands, in order, e.g., c(0.1, 0.2)

$frequencydomain$parameters$band.upper

Upper limits for the custom frequency bands, in order, e.g., c(0.3, 0.5)

General spectrum parameters

$frequencydomain$parameters$f.limits

A list giving the upper and lower limits for frequency estimation. The default is c(0, 0.4)

$frequencydomain$parameters$demean

Boolean indicating whether the spectrum should be demeaned. Default is TRUE.

$frequencydomain$parameters$normalization

The type of spectrum normalization to be use. Possible values are 'variance' and 'none' (default).

$frequencydomain$parameters$smooth

Boolean indicating whether the spectrum should be smoothed. Default is FALSE.

$frequencydomain$parameters$kernel

String giving the smoothing kernel. Default is "daniell".

$frequencydomain$parameters$smooth.degree

Degree of smoothing. Default is 5.

$frequencydomain$parameters$ofac

Lomb-Scargle oversampling factor.

$frequencydomain$parameters$hifac

Lomb-Scargle hifac. Frequencies are estimated up until hifac * average sampling frequency.

Geometric settings

$geometric$metric.list

A list of geometric metrics. Default is c("sd1", "sd2", "triangular.index", "tinn").

$geometric$triangular.index$binwidth

Bin width for the triangular index. Default is 128.

$geometric$tinn$binwidth

Bin width for the TINN metric. Default is 128.

Nonlinear settings

$nonlinear$metric.list

A list of nonlinear metrics. Default is c("sampen", "apen") for both Sample Entropy and Approximate Entropy.

$geometric$embedding_dimension

The embedding dimension. Default is 2.


bwrc/colibri documentation built on May 13, 2019, 9:10 a.m.