X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=man%2Fadd.scale.bar.Rd;h=3f1ee59c75332f99f3dbb567113e51db73735581;hb=dff741171e7afe3f9aaa2d9cb19c2f91995e8623;hp=57a1daafd5bbd6aba6a40ee534ed29b56874d040;hpb=f512087dd94a7dc3462a9f31b48f61214cdc0f5e;p=ape.git diff --git a/man/add.scale.bar.Rd b/man/add.scale.bar.Rd index 57a1daa..3f1ee59 100644 --- a/man/add.scale.bar.Rd +++ b/man/add.scale.bar.Rd @@ -2,14 +2,20 @@ \alias{add.scale.bar} \title{Add a Scale Bar to a Phylogeny Plot} \usage{ -add.scale.bar(x, y, length = NULL, ...) +add.scale.bar(x, y, length = NULL, ask = FALSE, + lwd = 1, lcol = "black", ...) } \arguments{ \item{x}{x location of the bar (can be left missing).} \item{y}{y location of the bar (can be left missing).} \item{length}{a numeric value giving the length of the scale bar. If none is supplied, a value is calculated from the data.} - \item{...}{further arguments to be passed to \code{text}.} + \item{ask}{a logical; if \code{TRUE} the user is asked to click where + to draw the bar. The default is \code{FALSE}.} + \item{lwd}{the width of the bar.} + \item{lcol}{the colour of the bar (use \code{col} for the colour of + the text).} + \item{\dots}{further arguments to be passed to \code{text}.} } \description{ This function adds a horizontal bar giving the scale of the branch @@ -19,16 +25,16 @@ add.scale.bar(x, y, length = NULL, ...) \details{ By default, the bar is placed in a corner of the graph depending on the direction of the tree. Otherwise both \code{x} and \code{y} must - be specified (if only one is given it is ignored). + be specified (if only one is given it is ignored). - The further arguments (\code{...}) are used to format the text. They + The further arguments (\code{\dots}) are used to format the text. They may be \code{font}, \code{cex}, \code{col}, and so on (see examples below, and the help page on \code{\link[graphics]{text}}). The function \code{\link[graphics]{locator}} may be used to determine the \code{x} and \code{y} arguments. } -\author{Emmanuel Paradis \email{Emmanuel.Paradis@mpl.ird.fr}} +\author{Emmanuel Paradis} \seealso{ \code{\link{plot.phylo}}, \code{\link{axisPhylo}}, \code{\link[graphics]{locator}}