tct_tree: Tree-like Factors

In bocinsky/treecats: Tree-like Factors in R

Description

The function tct_tree is used to encode a vector as a tree-like ordered factor. An tct_tree object is a factor, in that it inherits the factor and ordered classes, and can therefor be manipulated as such. The tct_tree class adds an attribute, tct_levels, that is a directed graph of class igraph.

Usage

tct_tree(x = factor(ordered = TRUE), tct_levels, ...)

tct_is_tree(x)

is.tct_tree(x)

tct_as_tree(x)

as.tct_tree(x)

tct_levels(x)

tct_levels(x) <- value

Arguments

x	a vector of data.
tct_levels	an optional directed igraph object defining the ontology.
...	other parameters passed on to factor.
value	a vector of character strings with length at least the number of levels of x.

Details

tct_is_tree, is.tct_tree, tct_as_tree, and as.tct_tree, are the membership and coercion functions for the tct_tree class.

tct_levels provides access to the tct_levels attribute of a tct_tree. The first form returns the value of the levels of its argument and the second sets the attribute.

Functions

• tct_is_tree: Membership function for the tct_tree class.

• is.tct_tree: Membership function for the tct_tree class.

• tct_as_tree: Coercion function for the tct_tree class.

• as.tct_tree: Coercion function for the tct_tree class.

• tct_levels: Return the value of the tct_levels attribute of a tct_tree.

• tct_levels<-: Set the value of the tct_levels attribute of a tct_tree.

Examples

c("Kyle", "John", "Molly") %>%
  tct_tree()

bocinsky/treecats documentation built on May 25, 2019, 3:24 p.m.