get_exit_type: Get exit type (from a vector 'x' of FFT exit descriptions)

View source: R/util_abc.R

get_exit_typeR Documentation

Get exit type (from a vector x of FFT exit descriptions)

Description

get_exit_type checks and converts a vector x of FFT exit descriptions into exits of an FFT that correspond to the current options of exit_types (as a global constant).

Usage

get_exit_type(x, verify = TRUE)

Arguments

x

A vector of FFT exit descriptions.

verify

A flag to turn verification on/off (as logical). Default: verify = TRUE.

Details

get_exit_type also verifies that the exit types conform to an FFT (e.g., only the exits of the final node are bi-directional).

Value

A vector of exit_types (or an error).

See Also

FFTrees for creating FFTs from and applying them to data.

Other utility functions: get_best_tree(), get_fft_df()

Examples

get_exit_type(c(0, 1, .5))
get_exit_type(c(FALSE,   " True ",  2/4))
get_exit_type(c("noise", "signal", "final"))
get_exit_type(c("left",  "right",  "both"))


ndphillips/FFTrees documentation built on April 25, 2024, 1:07 a.m.