data.tree: Sort – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Sort

Sort children of a Node or an entire data.tree structure

Description

You can sort with respect to any argument of the tree. But note that sorting has side-effects, meaning that you modify the underlying, original data.tree object structure.

Usage

Sort(node, attribute, ..., decreasing = FALSE, recursive = TRUE)

Arguments

`node`	The node whose children are to be sorted
`attribute`	determines what is collected. The `attribute` can be a.) the name of a field or a property/active of each `Node` in the tree, e.g. `acme$Get("p")` or `acme$Get("position")` b.) the name of a method of each `Node` in the tree, e.g. `acme$Get("levelZeroBased")`, where e.g. `acme$levelZeroBased <- function() acme$level - 1` c.) a function, whose first argument must be a `Node` e.g. `acme$Get(function(node) node$cost * node$p)`
`...`	any parameters to be passed on the the attribute (in case it's a method or a function)
`decreasing`	sort order
`recursive`	if `TRUE`, Sort will be called recursively on the `Node`'s children. This allows sorting an entire tree.

Value

Returns the node on which Sort is called, invisibly. This can be useful to chain Node methods.

Examples

data(acme)
acme$Do(function(x) x$totalCost <- Aggregate(x, "cost", sum), traversal = "post-order")
Sort(acme, "totalCost", decreasing = FALSE)
print(acme, "totalCost")

data.tree

General Purpose Hierarchical Data Structure

v1.0.0

GPL (>= 2)

Authors

Russ Hyde [ctb] (improve dependencies), Chris Hammill [ctb] (improve getting), Facundo Munoz [ctb] (improve list conversion), Markus Wamser [ctb] (fixed some typos), Pierre Formont [ctb] (additional features), Kent Russel [ctb] (documentation), Noam Ross [ctb] (fixes), Duncan Garmonsway [ctb] (fixes), Christoph Glur [aut, cre] (R interface)

Initial release

2020-07-31