ggpol (version 0.0.5)

GeomConfmat: Confusion Matrix

Description

Plot a confusion matrix.

Usage

geom_confmat(mapping = NULL, data = NULL, stat = "confmat",
  position = "identity", width = NULL, height = NULL,
  annotate = TRUE, text.perc = FALSE, text.digits = 3,
  text.alpha = NULL, text.angle = NULL, text.colour = NULL,
  text.family = NULL, text.fontface = NULL, text.group = NULL,
  text.hjust = NULL, text.lineheight = NULL, text.size = NULL,
  text.vjust = NULL, ..., na.rm = FALSE, show.legend = NA,
  inherit.aes = TRUE)
stat_confmat(mapping = NULL, data = NULL, geom = "tile",
  position = "identity", show.legend = NA, inherit.aes = TRUE,
  na.rm = FALSE, normalize = FALSE, ...)

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.

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.

width

The tile height.

height

The tile width.

annotate

Boolean indicator for whether to include values as text in each tile.

text.perc

Boolean indicator for whether to add `%` to the end of each value.

text.digits

Numeric vector equal to length one, indicating the number of digits to display. `round(x, text.digits)`.

text.alpha

Alpha value for the text grobs.

text.angle

Angle value for the text grobs.

text.colour

Colour of the text grobs.

text.family

Font family of the text grobs.

text.fontface

Font face of the text grobs.

text.group

Groups of the text grobs.

text.hjust

Hjust of the text grobs.

text.lineheight

Lineheight of the text grobs.

text.size

Size of the text grobs.

text.vjust

Vjust of the text grobs.

...

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.

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

geom

The geometric object to use display the data

normalize

Boolean indicator for whether to scale the frequency values.

Examples

# NOT RUN {
x <- sample(LETTERS[seq(4)], 50, replace = TRUE)
y <- sample(LETTERS[seq(4)], 50, replace = TRUE)

ggplot() + 
  geom_confmat(aes(x = x, y = y), normalize = TRUE, text.perc = TRUE)


# }