read_fft_df: Read an FFT definition from tree definitions

View source: R/util_gfft.R

read_fft_dfR Documentation

Read an FFT definition from tree definitions

Description

read_fft_df reads and returns the definition of a single FFT (as a tidy data frame) from the multi-line FFT definitions of an FFTrees object.

read_fft_df allows reading individual tree definitions to manipulate them with other tree trimming functions.

write_fft_df provides the inverse functionality.

Usage

read_fft_df(ffts_df, tree = 1)

Arguments

ffts_df

A set of FFT definitions (as a data frame, usually from an FFTrees object, with suitable variable names to pass verify_ffts_df.

tree

The ID of the to-be-selected FFT (as an integer), corresponding to a tree in ffts_df. Default: tree = 1.

Value

One FFT definition (as a data frame in tidy format, with one row per node).

See Also

get_fft_df for getting the FFT definitions of an FFTrees object; write_fft_df for writing one FFT to tree definitions; add_fft_df for adding FFTs to tree definitions; FFTrees for creating FFTs from and applying them to data.

Other tree definition and manipulation functions: add_fft_df(), add_nodes(), drop_nodes(), edit_nodes(), flip_exits(), get_fft_df(), reorder_nodes(), select_nodes(), write_fft_df()


FFTrees documentation built on June 7, 2023, 5:56 p.m.