rescaleTreeSupport: Rboretum Tree Support Rescaler

View source: R/rescaleTreeSupport.R

rescaleTreeSupportR Documentation

Rboretum Tree Support Rescaler

Description

This function takes the output of getAlignmentSupport, and returns a numeric vector of total, summed support that has been rescaled

Usage

rescaleTreeSupport(tree_support, scale, scale_range, return_total)

Arguments

tree_support

Output of getAlignmentSupport

scale

Scaling factor. Options include:

  • Single numeric value [return a repeated vector of this value (e.g. to set all geom_nodepoint to this size)]

  • Two-item numeric vector [return summation values that have been rescaled to fit between c(min,max) (e.g. rescale millions of sites to range between c(1,20))]

  • "log" [return log-transformed totals]

scale_range

OPTIONAL: Set range of values to scale by giving a c(min,max). Values below min or above max will be set to the minimum/maximum value without it. [Default: Use all data]

return_total

OPTIONAL: If TRUE, return raw sum total support values for each clade

Value

Numeric vector the length of the number of clades, and corresponding to rescaled total support values


BobLiterman/Rboretum documentation built on July 6, 2023, 7:46 p.m.