Extra Coordinate Systems, 'Geoms', Statistical Transformations, Scales and Fonts for 'ggplot2'
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

120 lines
4.3 KiB

7 years ago
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/stateface.r
\name{geom_stateface}
\alias{geom_stateface}
\title{Use ProPublica's StateFace font in ggplot2 plots}
\usage{
geom_stateface(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{
5 years ago
\item{mapping}{Set of aesthetic mappings created by \code{\link[=aes]{aes()}} or
\code{\link[=aes_]{aes_()}}. If specified and \code{inherit.aes = TRUE} (the
7 years ago
default), it is combined with the default mapping at the top level of the
plot. You must supply \code{mapping} if there is no plot mapping.}
\item{data}{The data to be displayed in this layer. There are three
5 years ago
options:
7 years ago
5 years ago
If \code{NULL}, the default, the data is inherited from the plot
data as specified in the call to \code{\link[=ggplot]{ggplot()}}.
7 years ago
5 years ago
A \code{data.frame}, or other object, will override the plot
data. All objects will be fortified to produce a data frame. See
\code{\link[=fortify]{fortify()}} for which variables will be created.
7 years ago
5 years ago
A \code{function} will be called with a single argument,
the plot data. The return value must be a \code{data.frame.}, and
will be used as the layer data.}
7 years ago
\item{stat}{The statistical transformation to use on the data for this
layer, as a string.}
\item{position}{Position adjustment, either as a string, or the result of
a call to a position adjustment function.}
5 years ago
\item{...}{Other arguments passed on to \code{\link[=layer]{layer()}}. These are
7 years ago
often aesthetics, used to set an aesthetic to a fixed value, like
\code{color = "red"} or \code{size = 3}. They may also be parameters
to the paired geom/stat.}
5 years ago
\item{parse}{If \code{TRUE}, the labels will be parsed into expressions and
7 years ago
displayed as described in ?plotmath}
7 years ago
\item{nudge_x, nudge_y}{Horizontal and vertical adjustment to nudge l
abels by. Useful for offsetting text from points, particularly
on discrete scales.}
7 years ago
\item{check_overlap}{If \code{TRUE}, text that overlaps previous text in the
7 years ago
same layer will not be plotted.}
7 years ago
\item{na.rm}{If \code{FALSE}, the default, missing values are removed with
a warning. If \code{TRUE}, missing values are silently removed.}
7 years ago
\item{show.legend}{logical. Should this layer be included in the legends?
\code{NA}, the default, includes if any aesthetics are mapped.
5 years ago
\code{FALSE} never includes, and \code{TRUE} always includes.
It can also be a named logical vector to finely select the aesthetics to
display.}
7 years ago
\item{inherit.aes}{If \code{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
5 years ago
the default plot specification, e.g. \code{\link[=borders]{borders()}}.}
7 years ago
}
\description{
The \code{label} parameter can be either a 2-letter state abbreviation
or a full state name. \code{geom_stateface()} will take care of the
translation to StateFace font glyph characters.
}
\details{
The package will also take care of loading the StateFace font for
PDF and other devices, but to use it with the on-screen ggplot2
device, you'll need to install the font on your system.
\code{ggalt} ships with a copy of the StateFace TTF font. You can
run \code{show_stateface()} to get the filesystem location and then
load the font manually from there.
\if{html}{
A sample of the output from \code{geom_stateface()}:
\figure{geomstateface01.png}{options: width="100\%" alt="Figure: geomstateface01.png"}
}
\if{latex}{
A sample of the output from \code{geom_stateface()}:
\figure{geomstateface01.png}{options: width=10cm}
}
7 years ago
}
\examples{
\dontrun{
library(ggplot2)
library(ggalt)
# Run show_stateface() to see the location of the TTF StateFace font
# You need to install it for it to work
set.seed(1492)
dat <- data.frame(state=state.abb,
x=sample(100, 50),
y=sample(100, 50),
col=sample(c("#b2182b", "#2166ac"), 50, replace=TRUE),
sz=sample(6:15, 50, replace=TRUE),
stringsAsFactors=FALSE)
gg <- ggplot(dat, aes(x=x, y=y))
gg <- gg + geom_stateface(aes(label=state, color=col, size=sz))
gg <- gg + scale_color_identity()
gg <- gg + scale_size_identity()
gg
}
}
7 years ago
\seealso{
Other StateFace operations: \code{\link{load_stateface}},
\code{\link{show_stateface}}
}
5 years ago
\concept{StateFace operations}