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.
59 lines
2.4 KiB
59 lines
2.4 KiB
6 years ago
|
% Generated by roxygen2: do not edit by hand
|
||
|
% Please edit documentation in R/geom_cartogram.r
|
||
|
\name{geom_cartogram}
|
||
|
\alias{geom_cartogram}
|
||
|
\title{Polygons from a reference map}
|
||
|
\usage{
|
||
|
geom_cartogram(mapping = NULL, data = NULL, stat = "identity", ..., map,
|
||
|
na.rm = FALSE, show.legend = NA, inherit.aes = TRUE)
|
||
|
}
|
||
|
\arguments{
|
||
|
\item{mapping}{Set of aesthetic mappings created by \code{\link{aes}} or
|
||
|
\code{\link{aes_}}. If specified and \code{inherit.aes = TRUE} (the
|
||
|
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
|
||
|
options:
|
||
|
|
||
|
If \code{NULL}, the default, the data is inherited from the plot
|
||
|
data as specified in the call to \code{\link{ggplot}}.
|
||
|
|
||
|
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}} for which variables will be created.
|
||
|
|
||
|
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.}
|
||
|
|
||
|
\item{stat}{The statistical transformation to use on the data for this
|
||
|
layer, as a string.}
|
||
|
|
||
|
\item{...}{other arguments passed on to \code{\link{layer}}. These are
|
||
|
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.}
|
||
|
|
||
|
\item{map}{Data frame that contains the map coordinates. This will
|
||
|
typically be created using \code{\link{fortify}} on a spatial object.
|
||
|
It must contain columns \code{x}, \code{long} or \code{longitude},
|
||
|
\code{y}, \code{lat} or \code{latitude} and \code{region} or \code{id}.}
|
||
|
|
||
|
\item{na.rm}{If \code{FALSE}, the default, missing values are removed with
|
||
|
a warning. If \code{TRUE}, missing values are silently removed.}
|
||
|
|
||
|
\item{show.legend}{logical. Should this layer be included in the legends?
|
||
|
\code{NA}, the default, includes if any aesthetics are mapped.
|
||
|
\code{FALSE} never includes, and \code{TRUE} always includes.}
|
||
|
|
||
|
\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
|
||
|
the default plot specification, e.g. \code{\link{borders}}.}
|
||
|
}
|
||
|
\description{
|
||
|
This is pure annotation, so does not affect position scales.
|
||
|
}
|
||
|
|