xdvir (version 0.1-2)

geom_latex: Latex Data Symbols in ggplot2 Plots

Description

This geom draws text labels similar to ggplot2::geom_text(), but with the text interpreted as a LaTeX fragment. Most styling parameters can be used as aesthetics and can be applied separately to each text label drawn.

Usage

geom_latex(mapping=NULL, data=NULL, stat="identity",
           position="identity", ...,
           nudge_x=0, nudge_y=0,
           width=NA,
           dpi=NA, packages=NULL,
           engine=getOption("xdvir.engine"),
           na.rm=FALSE,
           show.legend=NA, inherit.aes=TRUE)

Value

A ggplot2 layer that can be added to a plot created with

ggplot2::ggplot().

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. Cannot be jointy specified with nudge_x or nudge_y.

...

Other arguments passed on to layer(). These are often aesthetics, used to set an aesthetic to a fixed value, like colour = "red" or size = 3. They may also be parameters to the paired geom/stat.

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.

width

Either NA or a numeric value or a unit specifying the width for typesetting. NA means the natural width of the label.

dpi

Resolution (dots per inch).

packages

The LaTeX packages to be used. May be the name of a LaTeX package (character) or a "LaTeXpackage" object.

engine

The TeX engine that should be used to render the LaTeX. May be the name of a TeX engine (character) or a "TeXengine" object.

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().

Aesthetics

geom_latex() understands the following aesthetics (required aesthetics are in bold; select aesthetics are annotated):

• x

• y

• label

• alpha

• angle

• colour Default color of label text and label outline.

• family

• group

• hjust

• lineheight

• size Default font size of label text.

• vjust