R/geom_axis_text.R

In YuLab-SMU/ggtreeExtra: An R Package To Add Geometric Layers On Circular Or Other Layout Tree Of "ggtree"

## ##' add the axis of layer of geom_fruit.
## ##'
## ##' 'geom_axis_text' was designed to add the axis of layer of geom_fruit using
## ##' 'geom_text'. So the dot parameters can refer the arguments of 'geom_text',
## ##'  except `data` and `mapping`. 
## ##' 
## ##' @title geom_axis_text
## ##' @param angle numeric, the angle of text, default is 0 .
## ##' @param size numeric, the size of text, default is 0.8 .
## ##' @param nlayer integer, the specified layer of geom_fruit, default is NULL,
## ##' which mean the last layer.
## ##' @param text character, the text of axis x for layer using single column data, 
## ##' default is NULL.
## ##' @param nbreak integer, when the axis x is continuous, default is 4.
## ##' @param linesize numeric, the size of line, default is 0.1.
## ##' @param linecolour character, the color of line, default is "grey50".
## ##' @param linealpha character, the colour transparency of line, default is 1. 
## ##' @param ... additional parameters for 'geom_text'.
## ##' @return text object of ggplot2.
## ##' @export
## ##' @author Shuangbin Xu
## ##' @examples
## ##' library(ggplot2)
## ##' library(ggtree)
## ##' library(ggstar)
## ##' set.seed(1024)
## ##' tr <- rtree(100)
## ##' dd <- data.frame(id=tr$tip.label, value=abs(rnorm(100)))
## ##' dt <- data.frame(id=tr$tip.label, group=c(rep("A", 50), rep("B", 50)))
## ##' p <- ggtree(tr, layout="fan", open.angle=10)
## ##' p <- p %<+% dd %<+% dt
## ##' p1 <- p + geom_fruit(
## ##'               geom=geom_star,
## ##'               mapping=aes(y=id, fill=group),
## ##'               size=2.5,
## ##'               starstroke=0
## ##'           ) +
## ##'           geom_fruit(
## ##'               geom=geom_bar,
## ##'               mapping=aes(x=value, y=id),
## ##'               orientation="y",
## ##'               stat="identity"
## ##'           ) +
## ##'           geom_axis_text(angle=-45, hjust=0)
## geom_axis_text <- function(angle=0, 
##                            size=0.8, 
##                            nlayer=NULL, 
##                            text=NULL, 
##                            nbreak=4, 
##                            linesize=0.1,
##                            linecolour="grey50",
##                            linealpha=1,
##                            ...){
##     params <- list(...)
##     if (!is.null(params$linecolor)){
##         linecolour <- params$linecolor
##         params$linecolor <- NULL
##     }
##     structure(
##         list(
##           angle = angle, 
##           size = size,
##           nlayer = nlayer,
##           text = text,
##           nbreak = nbreak,
##           linesize=linesize,
##           linecolour=linecolour,
##           linealpha=linealpha,
##           params = params
##         ), 
##         class="fruit_axis_text"
##     )
## }