addSNPScale: Add a SNP scale to phylogeny

Description Usage Arguments

View source: R/addSNPScale.R

Description

Function that adds a SNP scale onto a plotted phylogeny

Usage

1
2
3
4
5
6
7
8
9
addSNPScale(
  x = NULL,
  y = NULL,
  position = NULL,
  size = 1,
  lineWidth = 1,
  cex = 1,
  offset = 0.5
)

Arguments

x

An optional numeric X coordinate for the scale

y

An optional numeric Y coordinate for the scale

position

An optional character vector detailing the location of the plot (top, middle, left, right, etc.)

size

The size (in SNPs) of the scale

lineWidth

A numeric scaling factor to change the width of the scale line. Defaults to 1. Equivalent to lwd

cex

A numeric scaling factor to chancge the size of the scale label. Defaults to 1.

offset

This value controls the distance (‘offset’) of the text label from the scale in fractions of a character width. Defaults to 0.5.


JosephCrispell/plotteR documentation built on June 6, 2021, 7:24 p.m.