| Type: | Package |
| Title: | Forest/Tree Data Frames |
| Version: | 0.3.0 |
| Description: | Provides data frames for forest or tree data structures. You can create forest data structures from data frames and process them based on their hierarchies. |
| License: | MIT + file LICENSE |
| Encoding: | UTF-8 |
| Depends: | R (≥ 4.1.0) |
| Imports: | cli, dplyr, lifecycle, pillar, purrr, rlang, tibble, tidygraph, tidyselect, vctrs (≥ 0.5.2) |
| Suggests: | covr, testthat (≥ 3.0.0) |
| Config/testthat/edition: | 3 |
| URL: | https://github.com/UchidaMizuki/timbr, https://uchidamizuki.github.io/timbr/ |
| BugReports: | https://github.com/UchidaMizuki/timbr/issues |
| Config/roxygen2/version: | 8.0.0 |
| NeedsCompilation: | no |
| Packaged: | 2026-07-16 22:58:23 UTC; uchid |
| Author: | Mizuki Uchida [aut, cre] |
| Maintainer: | Mizuki Uchida <uchidamizuki@vivaldi.net> |
| Repository: | CRAN |
| Date/Publication: | 2026-07-16 23:10:02 UTC |
timbr: Forest/Tree Data Frames
Description
Provides data frames for forest or tree data structures. You can create forest data structures from data frames and process them based on their hierarchies.
Author(s)
Maintainer: Mizuki Uchida uchidamizuki@vivaldi.net
Authors:
Mizuki Uchida uchidamizuki@vivaldi.net
See Also
Useful links:
Report bugs at https://github.com/UchidaMizuki/timbr/issues
Coerce to a forest
Description
Coerce to a forest
Usage
as_forest(x, ...)
Arguments
x |
An object. |
... |
Unused, for extensibility. |
Value
A forest.
Children of the forest
Description
Convert a forest into a forest consisting of its child nodes.
Usage
children(data, name = NULL)
Arguments
data |
A forest. |
name |
|
Value
A forest.
Climb a forest from parents to children
Description
Climb a forest from parents to children with one or more node names.
Usage
climb(.data, ..., .recurse = TRUE, .deep)
Arguments
.data |
A forest. |
... |
A list of node names to climb the forest. |
.recurse |
Whether to search recursively by node names or not? |
.deep |
(Deprecated) Whether to search recursively by node names or not? |
Value
A forest.
Constructs a forest by one or more variables
Description
forest_by() constructs a forest by one or more variables.
Usage
forest_by(.data, ...)
Arguments
.data |
A data frame. |
... |
Variables. |
Value
A forest.
Leaf nodes of a forest
Description
Leaf nodes of a forest
Usage
leaves(data)
Arguments
data |
A forest. |
Value
A forest.
Apply a function hierarchically to a forest
Description
![[Defunct]](./figures/lifecycle-defunct.svg)
map_forest() has been removed. Please use traverse() instead.
Usage
map_forest(.x, .f, ..., .climb = FALSE)
Arguments
.x |
A forest |
.f |
A function, formula, or vector (not necessarily atomic). |
... |
Additional arguments passed on to the mapped function. |
.climb |
Climbing or descending? |
Value
A forest.
Get node names
Description
Get node names
Usage
node_name()
Value
A character vector.
Get node values
Description
Get node values
Usage
node_value()
Value
A vector.
Apply a function hierarchically to a forest
Description
Apply a function hierarchically to a forest in the climbing or descending direction.
Usage
traverse(.x, .f, ..., .climb = FALSE)
Arguments
.x |
A forest |
.f |
A function, formula, or vector (not necessarily atomic). |
... |
Additional arguments passed on to the mapped function. |
.climb |
Climbing or descending? |
Value
A forest.