defineDabomColNms: Define Column Names for DABOM matrix

View source: R/defineDabomColNms.R

defineDabomColNmsR Documentation

Define Column Names for DABOM matrix

Description

based on a parent-child table, this returns a vector of nodes to help create a consistent series of DABOM input matrices.

Usage

defineDabomColNms(
  root_site = NA,
  parent_child,
  configuration,
  second_node = TRUE
)

Arguments

root_site

determines which version of DABOM the user is running.

parent_child

parent-child table. Could be created from 'buildParentChild()' from 'PITcleanr' package.

configuration

configuration file. Could be created from 'buildConfig()' from 'PITcleanr' package.

second_node

Default option is 'TRUE' which defines the 'bottom_sites' as the second order nodes above the 'root_site', (i.e., 'node_order == 2'). If 'FALSE', some sites are hard-coded depending on what the 'root_site' is set to. Default is 'TRUE'; otherwise 'bottom_sites' should be defined within the 'defineDabomColNms()' function

Author(s)

Kevin See

Examples

defineDabomColNms()

KevinSee/DABOM documentation built on April 4, 2024, 9:28 a.m.