Diff of /man/gene_highlights.Rd [000000] .. [0f2269]

Switch to unified view

a b/man/gene_highlights.Rd
1
% Generated by roxygen2: do not edit by hand
2
% Please edit documentation in R/GeneHighlights.R
3
\name{gene_highlights}
4
\alias{gene_highlights}
5
\title{Add gene highlights to a ggtree object}
6
\usage{
7
gene_highlights(ggtree_obj, genes_to_highlight, hilight_extend = 18)
8
}
9
\arguments{
10
\item{ggtree_obj}{A ggtree object to which the highlights will be added.}
11
12
\item{genes_to_highlight}{A data frame containing genes and their corresponding colors.}
13
14
\item{hilight_extend}{Integer, the extension of the highlight fan in degrees.}
15
}
16
\value{
17
A ggtree object with added gene highlights.
18
}
19
\description{
20
This function enhances a `ggtree` plot by adding highlights for specific genes. It adds both a semi-transparent fan-shaped
21
highlight and a point at the node corresponding to each gene. Colors for each gene can be customized.
22
}
23
\examples{
24
data("gtree", package = "TransProR")
25
26
# Define genes and their colors
27
genes_df <- data.frame(Symble = c("t5", "t9"),
28
                       color = c("#FF0000", "#0000FF"))
29
30
# Add highlights
31
gtree <- gene_highlights(gtree, genes_to_highlight = genes_df)
32
33
}