Package: treeDbalance 1.0.1

treeDbalance: Computation of 3D Tree Imbalance

The main goal of the R package 'treeDbalance' is to provide functions for the computation of several measurements of 3D node imbalance and their respective 3D tree imbalance indices, as well as to introduce the new 'phylo3D' format for rooted 3D tree objects. Moreover, it encompasses an example dataset of 3D models of 63 beans in 'phylo3D' format. Please note that this R package was developed alongside the project described in the manuscript 'Measuring 3D tree imbalance of plant models using graph-theoretical approaches' by M. Fischer, S. Kersting, and L. Kühn (2023) <arxiv:2307.14537>, which provides precise mathematical definitions of the measurements. Furthermore, the package contains several helpful functions, for example, some auxiliary functions for computing the ancestors, descendants, and depths of the nodes, which ensures that the computations can be done in linear time. Most functions of 'treeDbalance' require as input a rooted tree in the 'phylo3D' format, an extended 'phylo' format (as introduced in the R package 'ape' 1.9 in November 2006). Such a 'phylo3D' object must have at least two new attributes next to those required by the 'phylo' format: 'node.coord', the coordinates of the nodes, as well as 'edge.weight', the literal weight or volume of the edges. Optional attributes are 'edge.diam', the diameter of the edges, and 'edge.length', the length of the edges. For visualization purposes one can also specify 'edge.type', which ranges from normal cylinder to bud to leaf, as well as 'edge.color' to change the color of the edge depiction. This project was supported by the joint research project DIG-IT! funded by the European Social Fund (ESF), reference: ESF/14-BM-A55-0017/19, and the Ministry of Education, Science and Culture of Mecklenburg-Western Pomerania, Germany, as well as by the the project ArtIGROW, which is a part of the WIR!-Alliance 'ArtIFARM – Artificial Intelligence in Farming' funded by the German Federal Ministry of Education and Research (FKZ: 03WIR4805).

Authors:Mareike Fischer [aut], Sophie Kersting [aut, cre], Luise Kühn [aut], Jule Möller [ctr]

treeDbalance_1.0.1.tar.gz
treeDbalance_1.0.1.zip(r-4.5)treeDbalance_1.0.1.zip(r-4.4)treeDbalance_1.0.1.zip(r-4.3)
treeDbalance_1.0.1.tgz(r-4.4-any)treeDbalance_1.0.1.tgz(r-4.3-any)
treeDbalance_1.0.1.tar.gz(r-4.5-noble)treeDbalance_1.0.1.tar.gz(r-4.4-noble)
treeDbalance_1.0.1.tgz(r-4.4-emscripten)treeDbalance_1.0.1.tgz(r-4.3-emscripten)
treeDbalance.pdf |treeDbalance.html
treeDbalance/json (API)
NEWS

# Install 'treeDbalance' in R:
install.packages('treeDbalance', repos = c('https://sophiekersting.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Datasets:

On CRAN:

This package does not link to any Github/Gitlab/R-forge repository. No issue tracker or development information is available.

35 exports 0.00 score 29 dependencies 143 downloads

Last updated 1 years agofrom:9007478e9d. Checks:OK: 7. Indexed: yes.

TargetResultDate
Doc / VignettesOKSep 17 2024
R-4.5-winOKSep 17 2024
R-4.5-linuxOKSep 17 2024
R-4.4-winOKSep 17 2024
R-4.4-macOKSep 17 2024
R-4.3-winOKSep 17 2024
R-4.3-macOKSep 17 2024

Exports:A_IndexaddImbalPhylo3DaddPhylo3Dall3DImbalIndicesalpha_Indexangle3dVeccombined3DIndexcross3d_proddist3dToLineextendPhylogetAncsgetChildrengetDescendantsgetDescsgetDistFromLeafgetDistFromRootgetIncEdgeLensgetIncEdgeWeightsgetLeavesgetNodeDepthsgetNodesAtDepthgetSubtrCentrimbalInt_eimbalProfileimbalProfile_eimbalSubdiv_AimbalSubdiv_alphaimbalSubdiv_MimbalSubdiv_muM_IndexmakePhylo3DBalancedmu_IndexplotImbalPhylo3DplotPhylo3Drotate3dVec

Dependencies:base64encbslibcachemclidigestevaluatefastmapfontawesomefsgluehighrhtmltoolshtmlwidgetsjquerylibjsonliteknitrlifecyclemagrittrmemoisemimeR6rappdirsrglrlangrmarkdownsasstinytexxfunyaml

Readme and manuals

Help Manual

Help pageTopics
Calculation of integral-based distance- and angle-based 3D imbalance indicesall3DImbalIndices alpha_Index A_Index imbalInt_e imbalProfile_e mu_Index M_Index
Calculation of combined 3D imbalance indicescombined3DIndex
Examples of rooted 3D treesexample3Dtrees
Useful extensions to the phylo formatextendPhylo getAncs getChildren getDescendants getDescs getDistFromLeaf getDistFromRoot getIncEdgeLens getIncEdgeWeights getLeaves getNodeDepths getNodesAtDepth getSubtrCentr
Calculation of 3D imbalance profilesimbalProfile
Calculation of the centroid anglesangle3dVec imbalSubdiv_A imbalSubdiv_alpha
Calculation of the centroid distancescross3d_prod dist3dToLine imbalSubdiv_M imbalSubdiv_mu
Turn a rooted 3D tree into one of its balanced versionsmakePhylo3DBalanced rotate3dVec
Plot a phylo3D objectaddImbalPhylo3D addPhylo3D plotImbalPhylo3D plotPhylo3D