|
|
@ -4,7 +4,7 @@ |
|
|
|
\name{geom_statebins} |
|
|
|
\alias{geom_statebins} |
|
|
|
\alias{GeomStatebins} |
|
|
|
\title{A statebins Geom (WIP!)} |
|
|
|
\title{A statebins Geom} |
|
|
|
\format{An object of class \code{GeomStatebins} (inherits from \code{Geom}, \code{ggproto}, \code{gg}) of length 7.} |
|
|
|
\usage{ |
|
|
|
geom_statebins(mapping = NULL, data = NULL, border_col = "white", |
|
|
@ -14,21 +14,63 @@ geom_statebins(mapping = NULL, data = NULL, border_col = "white", |
|
|
|
|
|
|
|
GeomStatebins |
|
|
|
} |
|
|
|
\description{ |
|
|
|
WIP!!!!!!!!!!! Full geom documentation coming soon. See Details and the Examples for now. |
|
|
|
} |
|
|
|
\details{ |
|
|
|
For now, you pass in: |
|
|
|
\itemize{ |
|
|
|
\item \code{border_col} (border color of the state squares, default "\code{white}") |
|
|
|
\item \code{border_size} (thickness of the square state borders) |
|
|
|
\item \code{lbl_size} (the relative font size of the state label text, default \code{3}) |
|
|
|
\item \code{dark_lbl} (the color for the state label text when it shld be dark text on light background) |
|
|
|
\item \code{light_lbl} (the color for the state label text when it shld be light text on dark background) |
|
|
|
\item \code{radius} (corner radius --- \code{0} for a "square") |
|
|
|
} |
|
|
|
\arguments{ |
|
|
|
\item{mapping}{Set of aesthetic mappings created by \code{aes()} or |
|
|
|
\code{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{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{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{border_col}{border color of the state squares, default "\code{white}"} |
|
|
|
|
|
|
|
You also need to (ok, \emph{should}) pass in two \code{aes()} mappings: |
|
|
|
\item{border_size}{thickness of the square state borders} |
|
|
|
|
|
|
|
\item{lbl_size}{font size (relative) of the label text} |
|
|
|
|
|
|
|
\item{dark_lbl, light_lbl}{colrs to be uses when the label should be dark or light. |
|
|
|
The function automagically computes when this should be.} |
|
|
|
|
|
|
|
\item{radius}{the corner radius} |
|
|
|
|
|
|
|
\item{...}{other arguments passed on to \code{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{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. |
|
|
|
It can also be a named logical vector to finely select the aesthetics to |
|
|
|
display.} |
|
|
|
|
|
|
|
\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{borders()}.} |
|
|
|
} |
|
|
|
\description{ |
|
|
|
Pass in a data frame of states and values and let this do the work. It enables |
|
|
|
easy faceting and makes it simpler to have a uniform legend across all the |
|
|
|
plots.\cr |
|
|
|
\cr |
|
|
|
There are two special/critical \code{aes()} mappings:\cr |
|
|
|
\cr |
|
|
|
\itemize{ |
|
|
|
\item \code{state} (so the geom knows which column to map the state names/abbrevs to) |
|
|
|
\item \code{fill} (which column you're mapping the filling for the squares with) |
|
|
|