SVGTree: SVG Tree

SVGTreeR Documentation

SVG Tree

Description

Plots one of the character reconstructions embodied within an SVGCanvas object on a specified phylogenetic tree, returning SVG text that can be saved to file or included directly in an HTML document.

Usage

SVGTree(
  treeNo,
  canvas,
  char,
  stateLabels,
  treeNames,
  charIndex = 0,
  analysisLabels = character(0)
)

Arguments

treeNo

Integer specifying which of the trees on the SVGForest to plot

canvas

an object of class SVGForest.

char

Character string specifying character to optimise on the tree

stateLabels

Character vector specifying label for each applicable state of the character

treeNames

Character string naming the analysis used to generate each tree

charIndex

Character string specifying the number of the character, for inclusion under the SVG element's data-char attribute.

analysisLabels

Character vector specifying label for each analysis

Value

Character string describing an SVG object that depicts the tree, which can be written to file or included in markdown destined for HTML output.

Author(s)

Martin R. Smith


TGuillerme/Inapp documentation built on Feb. 4, 2024, 7:26 a.m.