R/geom_subgene_label.R
geom_subgene_label.Rd
geom_subgene_label()
can be used to add a text label to subgenes drawn
with geom_subgene_arrow()
.
geom_subgene_label(
mapping = NULL,
data = NULL,
stat = "identity",
position = "identity",
na.rm = FALSE,
show.legend = FALSE,
inherit.aes = TRUE,
padding.x = grid::unit(1, "mm"),
padding.y = grid::unit(0.1, "lines"),
align = "centre",
min.size = 4,
grow = F,
reflow = F,
height = grid::unit(3, "mm"),
...
)
Standard
geom arguments as for ggplot2::geom_text()
.
grid::unit()
object, giving horizontal or
vertical padding around the text. Defaults to 1 mm and 0.1 lines
respectively.
Where inside the subgene to place the text label. Default is 'centre'; other options are 'left' and 'right'.
Minimum font size, in points. If provided, text that would need to be shrunk below this size to fit inside the subgene will not be drawn. Defaults to 4 pt.
If TRUE
, text will be grown as well as shrunk to fill the
subgene.
If TRUE
, text will be reflowed (wrapped) to better fit the
subgene.
grid::unit()
object giving the maximum height of the text.
Defaults to 3 mm, which is the default height of gene arrows (and therefore
of subgenes) drawn with geom_gene_arrow()
.
geom_subgene_label()
uses the 'ggfittext' package to fit text to genes.
All text drawing options available in ggfittext::geom_fit_text()
(growing,
reflowing, etc.) are also available here. For full details on how these
options work, see the documentation for ggfittext::geom_fit_text()
.
Standard 'ggplot2' aesthetics for text are supported (see Aesthetics.)
xsubmin,xsubmax (start and end of the subgene; required)
y (molecule; required)
colour
size
alpha
family
fontface
angle