GENEAratio: Principal Frequency Ratio

View source: R/statistics.R

GENEAratioR Documentation

Principal Frequency Ratio

Description

Calculates the ratio of the principle step frequencies.

Usage

GENEAratio(principals, freq = "Freq", nfr = 3L, ...)

Arguments

principals

principal frequency

freq

single character naming single numeric variable in parent environment stating sampling frequency

nfr

single integer number of frames to search

...

other arguments to be swallowed

Details

Note this function is intended to be called from within an apply call in segmentation, hence the unusual syntax of defining the sampling frequency, freq as an object in the parent frame

Value

single numeric

Examples

    Freq <- 100
    GENEAratio(principals = c(0.1, 3.2, 0.3, 0.0, 0.2))

GENEAclassify documentation built on March 31, 2023, 9:01 p.m.