flip_exits: Flip exits in an FFT definition

View source: R/util_gfft.R

flip_exitsR Documentation

Flip exits in an FFT definition

Description

flip_exits reverses the exits of one or more nodes from an existing FFT definition (in the tidy data frame format).

flip_exits alters the value(s) of the non-final exits specified in nodes (from 0 to 1, or from 1 to 0). By contrast, exits of final nodes remain unchanged.

Duplicates in nodes are flipped only once (rather than repeatedly) and nodes not in the range 1:nrow(fft) are ignored.

flip_exits is a more specialized function than edit_nodes.

Usage

flip_exits(fft, nodes = NA, quiet = FALSE)

Arguments

fft

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

nodes

The FFT nodes whose exits are to be flipped (as an integer vector). Default: nodes = NA.

quiet

Hide feedback messages (as logical)? Default: quiet = FALSE.

Value

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

See Also

add_nodes for adding nodes to an FFT definition; edit_nodes for editing nodes in an FFT definition; drop_nodes for deleting nodes from an FFT definition; reorder_nodes for reordering nodes of an FFT definition; select_nodes for selecting nodes in an FFT definition; get_fft_df for getting the FFT definitions of an FFTrees object; read_fft_df for reading one FFT definition from 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(), get_fft_df(), read_fft_df(), reorder_nodes(), select_nodes(), write_fft_df()


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