add_nodes: Add nodes to an FFT definition

View source: R/util_gfft.R

add_nodesR Documentation

Add nodes to an FFT definition

Description

add_nodes allows adding one or more nodes to an existing FFT definition (in the tidy data frame format).

add_nodes allows to directly set and change the value(s) of class, cue, direction, threshold, and exit, in an FFT definition for the specified nodes.

There is only rudimentary verification for plausible entries. Importantly, however, as add_nodes is ignorant of data, the values of its variables are not validated for a specific set of data.

Values in nodes refer to their new position in the final FFT. Duplicate values of nodes are ignored (and only the last entry is used).

When a new exit node is added, the exit type of a former final node is set to the signal value (i.e., exit_types[2]).

Usage

add_nodes(
  fft,
  nodes = NA,
  class = NA,
  cue = NA,
  direction = NA,
  threshold = NA,
  exit = NA,
  quiet = FALSE
)

Arguments

fft

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

nodes

The FFT nodes to be added (as an integer vector). Values refer to their new position in the final FFT (i.e., after adding all nodes to fft). Default: nodes = NA.

class

The class values of nodes (as character).

cue

The cue names of nodes (as character).

direction

The direction values of nodes (as character).

threshold

The threshold values of nodes (as character).

exit

The exit values of nodes (as values from exit_types).

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

drop_nodes for deleting nodes from an FFT definition; edit_nodes for editing nodes in an FFT definition; flip_exits for reversing exits in 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(), drop_nodes(), edit_nodes(), flip_exits(), get_fft_df(), read_fft_df(), reorder_nodes(), select_nodes(), write_fft_df()


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