Browse code

Merge pull request #198 from Bisaloo/patch-1

Update doc to explain the function of some arguments

Guangchuang Yu authored on 10/10/2018 10:45:28 • GitHub committed on 10/10/2018 10:45:28
Showing 1 changed files

... ...
@@ -10,8 +10,10 @@
10 10
 ##' @param as.Date logical whether using Date class in time tree
11 11
 ##' @param yscale y scale
12 12
 ##' @param yscale_mapping yscale mapping for category variable
13
-##' @param ladderize logical
14
-##' @param right logical
13
+##' @param ladderize logical (default \code{TRUE}). Should the tree be re-organized to have a 'ladder'
14
+##' aspect?
15
+##' @param right logical. If \code{ladderize = TRUE}, should the ladder have the smallest clade on the
16
+##' right-hand side? See \code{\link[ape]{ladderize}} for more information. 
15 17
 ##' @param branch.length variable for scaling branch, if 'none' draw cladogram
16 18
 ##' @param ... additional parameter
17 19
 ##' @return tree
... ...
@@ -25,6 +27,7 @@
25 27
 ##' @importFrom ggplot2 coord_polar
26 28
 ##' @export
27 29
 ##' @author Yu Guangchuang
30
+##' @seealso \code{\link[ape]{ladderize}}
28 31
 ##' @examples
29 32
 ##' require(ape)
30 33
 ##' tr <- rtree(10)