ggformula (version 0.9.0)

gf_text: Formula interface to geom_text() and geom_label()

Description

geom_text adds text directly to the plot. geom_label draws a rectangle behind the text, making it easier to read.

Usage

gf_text(object = NULL, gformula = NULL, data = NULL, label, alpha,
  angle, color, family, fontface, group, hjust, lineheight, size, vjust,
  parse = FALSE, nudge_x = 0, nudge_y = 0, check_overlap = FALSE,
  xlab, ylab, title, subtitle, caption, geom = "text",
  stat = "identity", position = "nudge", show.legend = NA,
  show.help = NULL, inherit = TRUE, environment = parent.frame(),
  ...)
gf_label(object = NULL, gformula = NULL, data = NULL, label, alpha,
  angle, color, family, fontface, group, hjust, lineheight, size, vjust,
  parse, nudge_x = 0, nudge_y = 0, label.padding = unit(0.25,
  "lines"), label.r = unit(0.15, "lines"), label.size = 0.25, xlab,
  ylab, title, subtitle, caption, stat = "identity",
  position = "nudge", show.legend = NA, show.help = NULL,
  inherit = TRUE, environment = parent.frame(), ...)

Arguments

object

When chaining, this holds an object produced in the earlier portions of the chain. Most users can safely ignore this argument. See details and examples.

gformula

A formula with shape y ~ x. Faceting can be achieved by including | in the formula.

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.

label

The text to be displayed.

alpha

Opacity (0 = invisible, 1 = opaque).

angle

An angle for rotating the text.

color

A color or a formula used for mapping color.

family

A font family.

fontface

One of "plain", "bold", "italic", or "bold italic".

group

Used for grouping.

hjust, vjust

Numbers between 0 and 1 indicating how to justify text relative the the specified location.

lineheight

Line height.

size

A numeric size or a formula used for mapping size.

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.

nudge_y

Horizontal and vertical adjustment to nudge labels by. Useful for offsetting text from points, particularly on discrete scales.

check_overlap

If TRUE, text that overlaps previous text in the same layer will not be plotted.

xlab

Label for x-axis. See also gf_labs().

ylab

Label for y-axis. See also gf_labs().

title

Title, sub-title, and caption for the plot. See also gf_labs().

subtitle

Title, sub-title, and caption for the plot. See also gf_labs().

caption

Title, sub-title, and caption for the plot. See also gf_labs().

geom

A character string naming the geom used to make the layer.

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.

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.

show.help

If TRUE, display some minimal help.

inherit

A logical indicating whether default attributes are inherited.

environment

An environment in which to look for variables not found in data.

...

Additional arguments. Typically these are (a) ggplot2 aesthetics to be set with attribute = value, (b) ggplot2 aesthetics to be mapped with attribute = ~ expression, or (c) attributes of the layer as a whole, which are set with attribute = value.

label.padding

Amount of padding around label. Defaults to 0.25 lines.

label.r

Radius of rounded corners. Defaults to 0.15 lines.

label.size

Size of label border, in mm.

Value

a gg object

Specifying plot attributes

Positional attributes (a.k.a, aesthetics) are specified using the formula in gformula. Setting and mapping of additional attributes can be done through the use of additional arguments. Attributes can be set can be set using arguments of the form attribute = value or mapped using arguments of the form attribute = ~ expression.

In formulas of the form A | B, B will be used to form facets using facet_wrap() or facet_grid(). This provides an alternative to gf_facet_wrap() and gf_facet_grid() that is terser and may feel more familiar to users of lattice.

Evaluation

Evaluation of the ggplot2 code occurs in the environment of gformula. This will typically do the right thing when formulas are created on the fly, but might not be the right thing if formulas created in one environment are used to create plots in another.

See Also

ggplot2::geom_text()

Examples

# NOT RUN {
gf_text(Sepal.Length ~ Sepal.Width, data = iris,
  label = ~ Species, color = ~ Species, size = 2, angle = 30)
gf_point(Sepal.Length ~ Sepal.Width, data = iris, color = ~ Species) %>%
gf_text(Sepal.Length ~ Sepal.Width, data = iris,
  label = ~ Species, color = ~ Species,
  size = 2, angle = 0, hjust = 0, nudge_x  = 0.1, nudge_y = 0.1)

if (require(dplyr)) {
  iris_means <-
    iris %>%
    group_by(Species) %>%
    summarise(Sepal.Length = mean(Sepal.Length), Sepal.Width = mean(Sepal.Width))
  gf_point(Sepal.Length ~ Sepal.Width, data = iris, color = ~ Species) %>%
  gf_label(Sepal.Length ~ Sepal.Width, data = iris_means,
    label = ~ Species, color = ~ Species, size = 2, alpha = 0.7)
}
# }