Produce labelled contour lines of 2D density in ggplot2Source:
Contour lines representing 2D density are available already in
ggplot2, but the native
does not allow the lines to be labelled with the level of each contour.
geom_textdensity2d adds this ability.
geom_textdensity2d( mapping = NULL, data = NULL, stat = "density_2d", position = "identity", ..., contour_var = "density", n = 100, h = NULL, adjust = c(1, 1), lineend = "butt", linejoin = "round", linemitre = 10, na.rm = FALSE, show.legend = NA, inherit.aes = TRUE ) geom_labeldensity2d( mapping = NULL, data = NULL, stat = "density_2d", position = "identity", na.rm = FALSE, show.legend = NA, inherit.aes = TRUE, ..., contour_var = "density", n = 100, h = NULL, adjust = c(1, 1), lineend = "butt", linejoin = "round", linemitre = 10, label.padding = unit(0.25, "lines"), label.r = unit(0.15, "lines"), arrow = NULL )
Set of aesthetic mappings created by
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
mappingif there is no plot mapping.
The data to be displayed in this layer. There are three options:
NULL, the default, the data is inherited from the plot data as specified in the call to
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.
functionwill 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
functioncan be created from a
~ head(.x, 10)).
The statistical transformation to use on the data for this layer, as a string.
Position adjustment, either as a string, or the result of a call to a position adjustment function.
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. These can also be the following text-path parameters:
TRUE, breaks the path into two sections with a gap on either side of the label. If
FALSE, the path is plotted as a whole. Alternatively, if
NA, the path will be broken if the string has a
vjustbetween 0 and 1, and not otherwise. The default for the label variant is
FALSEand for the text variant is
TRUE(default), inverts any text where the majority of letters would upside down along the path, to improve legibility. If
FALSE, the path decides the orientation of text.
character(1)describing how multi-line text should be justified. Can either be
unitobject of length 1 to determine the offset of the text from the path. If this is
vjustparameter decides the offset. If not
offsetargument overrules the
TRUE, will coerce the labels into expressions, allowing for plotmath syntax to be used.
TRUE, keeps the letters of a label on a straight baseline and if
FALSE(default), lets individual letters follow the curve. This might be helpful for noisy paths.
unitobject of length 1 to determine the padding between the text and the path when the
gapparameter trims the path.
numeric(1)value between 0 and 100 that smooths the text without affecting the line portion of the geom. The default value of
0means no smoothing is applied.
logical(1)whether to interpret the text as html/markdown formatted rich text. Default:
FALSE. See also the rich text section of the details in
if TRUE, labels that are longer than their associated path will be removed.
Character string identifying the variable to contour by. Can be one of
"count". See the section on computed variables for details.
Number of grid points in each direction.
Bandwidth (vector of length two). If
NULL, estimated using
A multiplicative bandwidth adjustment to be used if 'h' is 'NULL'. This makes it possible to adjust the bandwidth while still using the a bandwidth estimator. For example,
adjust = 1/2means use half of the default bandwidth.
Line end style (round, butt, square).
Line join style (round, mitre, bevel).
Line mitre limit (number greater than 1).
FALSE, the default, missing values are removed with a warning. If
TRUE, missing values are silently removed.
logical. Should this layer be included in the legends?
NA, the default, includes if any aesthetics are mapped.
FALSEnever includes, and
TRUEalways includes. It can also be a named logical vector to finely select the aesthetics to display.
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.
Amount of padding around label. Defaults to 0.25 lines.
Radius of rounded corners. Defaults to 0.15 lines.
Arrow specification, as created by
geom_textdensity2d() understands the following aesthetics (required aesthetics are in bold):
In addition to aforementioned aesthetics,
geom_labeldensity2d() also understands:
spacing aesthetic allows fine control of spacing
of text, which is called 'tracking' in typography.
The default is 0 and units are measured in 1/1000 em.
Numbers greater than zero increase the spacing,
whereas negative numbers decrease the spacing.
Learn more about setting these aesthetics
Other geom layers that place text on paths.