geom_reltext: Add text to relative positions

Description Usage Arguments Details Value Aesthetics See Also

View source: R/geom_reltext.R

Description

geom_reltext() adds text labels to relative positions in a ggplot panel.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
geom_reltext(
  mapping = NULL,
  data = NULL,
  stat = "identity",
  position = "identity",
  ...,
  parse = FALSE,
  nudge_x = 0,
  nudge_y = 0,
  check_overlap = FALSE,
  na.rm = FALSE,
  show.legend = NA,
  inherit.aes = TRUE
)

Arguments

mapping

Set of aesthetic mappings created by aes() or aes_(). If specified and inherit.aes = TRUE (the default), it is combined with the default mapping at the top level of the plot. You must supply mapping if there is no plot mapping.

data

The data to be displayed in this layer. There are three options:

If NULL, the default, the data is inherited from the plot data as specified in the call to ggplot().

A data.frame, or other object, will override the plot data. All objects will be fortified to produce a data frame. See fortify() for which variables will be created.

A function will be called with a single argument, the plot data. The return value must be a data.frame, and will be used as the layer data. A function can be created from a formula (e.g. ~ head(.x, 10)).

stat

The statistical transformation to use on the data for this layer, as a string.

position

Position adjustment, either as a string, or the result of a call to a position adjustment function.

...

additional arguments passed to ggplot2::layer().

parse

If TRUE, the labels will be parsed into expressions and displayed as described in ?plotmath.

nudge_x

Horizontal and vertical adjustment to nudge labels by. Useful for offsetting text from points, particularly on discrete scales. Cannot be jointly specified with position.

nudge_y

Horizontal and vertical adjustment to nudge labels by. Useful for offsetting text from points, particularly on discrete scales. Cannot be jointly specified with position.

check_overlap

If TRUE, text that overlaps previous text in the same layer will not be plotted. check_overlap happens at draw time and in the order of the data. Therefore data should be arranged by the label column before calling geom_label() or geom_text().

na.rm

If FALSE, the default, missing values are removed with a warning. If TRUE, missing values are silently removed.

show.legend

logical. Should this layer be included in the legends? NA, the default, includes if any aesthetics are mapped. FALSE never includes, and TRUE always includes. It can also be a named logical vector to finely select the aesthetics to display.

inherit.aes

If FALSE, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from the default plot specification, e.g. borders().

Details

geom_reltext() adds text to relative positions in ggplot panels, i.e. the position of the text is expressed as a number between 0 and 1 (lower and upper axis limits) instead of a number on the scale of the displayed variables.

In corrmorant, it is widely used to display text labels relative to the panel margins instead of the data in the panel.

Value

An object of class Layer.

Aesthetics

geom_reltext() requires the following aesthetics:

In addition, it understands the same aesthetics as ggplot2::geom_text()

See Also

Used to position the output of stat_corrtext(), stat_corrtext() and stat_dia_names().


r-link/corrmorant documentation built on Jan. 10, 2021, 7:26 p.m.