X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=man%2FmakeLabel.Rd;h=be99abdd8ce8944d1b698abc3aa5aa6fd9706371;hb=a8d86ed3981c64b6d20316d54d3ed4d02c2b887e;hp=b48718b2f6efe37e131c982cd23c16afe0be2e1d;hpb=dd6a471eb1c239c03a082a67573603a20e5256ad;p=ape.git diff --git a/man/makeLabel.Rd b/man/makeLabel.Rd index b48718b..be99abd 100644 --- a/man/makeLabel.Rd +++ b/man/makeLabel.Rd @@ -5,6 +5,12 @@ \alias{makeLabel.multiPhylo} \alias{makeLabel.DNAbin} \title{Label Management} +\description{ + This is a generic function with methods for character vectors, trees + of class \code{"phylo"}, lists of trees of class \code{"multiPhylo"}, + and DNA sequences of class \code{"DNAbin"}. All options for the class + character may be used in the other methods. +} \usage{ makeLabel(x, ...) \method{makeLabel}{character}(x, len = 99, space = "_", make.unique = TRUE, @@ -30,13 +36,7 @@ makeLabel(x, ...) modified; \code{TRUE} by default.} \item{nodes}{a logical specifying whether node labels are to be modified; \code{TRUE} by default.} - \item{...}{further arguments to be passed to or from other methods.} -} -\description{ - This is a generic function with methods for character vectors, trees - of class \code{"phylo"}, lists of trees of class \code{"multiPhylo"}, - and DNA sequences of class \code{"DNAbin"}. All options for the class - character may be used in the other methods. + \item{\dots}{further arguments to be passed to or from other methods.} } \details{ The option \code{make.unique} does not work exactly in the same way @@ -48,7 +48,7 @@ makeLabel(x, ...) on. The number of digits added preserves the option `len'. The default for `len' makes labels short enough to be read by - PHYML. Clustal accepts labels up to 30 character long. + PhyML. Clustal accepts labels up to 30 character long. } \note{ The current version does not perform well when trying to make very @@ -57,10 +57,11 @@ makeLabel(x, ...) \value{ An object of the appropriate class. } -\author{Emmanuel Paradis \email{Emmanuel.Paradis@mpl.ird.fr}} +\author{Emmanuel Paradis} \seealso{ - \code{\link[base]{make.unique}}, \code{\link[base]{make.names}}, - \code{\link[base]{abbreviate}} + \code{\link{makeNodeLabel}}, \code{\link[base]{make.unique}}, + \code{\link[base]{make.names}}, \code{\link[base]{abbreviate}}, + \code{\link{mixedFontLabel}} } \examples{ x <- rep("a", 3)