-
Notifications
You must be signed in to change notification settings - Fork 12
/
map_qdata.Rd
61 lines (55 loc) · 2.02 KB
/
map_qdata.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
\name{map_qdata}
\alias{map_qdata}
\title{Create data for drawing maps}
\usage{
map_qdata(database, regions = ".", color = "gray50", border = "gray90", size = 4,
cartogram = FALSE, diffuse = 5, label = NULL, ...)
}
\arguments{
\item{database}{see \code{\link[maps]{map}}}
\item{regions}{see \code{\link[maps]{map}}}
\item{cartogram}{whether to transform the map data in
order to create a cartogram; if \code{TRUE}, the shape of
the cartogram will be determined by the \code{size}
parameter in the data (i.e. \code{data$.size}); see
\code{\link{cart_polygon}} for details}
\item{...}{passed to \code{\link{cart_polygon}}}
\item{color}{colors of graphical elements (default dark
gray) corresponding to rows of data; it can be a vector
of valid R colors, or a name of variable in \code{data}
(must be either a factor or a numeric variable), or an R
expression to calculate colors; \code{color} is used to
fill the interior of graphical elements}
\item{border}{colors for the border of graphical elements
(e.g. rectangles); \code{NA} means to suppress the
border}
\item{size}{sizes of rows; possible values are similar to
\code{color}, but when using a variable to generate
sizes, it must be a numeric variable}
}
\value{
A mutaframe of region names and labels, with an attribute
\code{MapData} containing the coordinates of polygons.
}
\description{
This function converts maps data in the \pkg{maps}
package to a suitable format for \pkg{cranvas}.
Optionally it transforms the data to make cartograms.
}
\details{
The function \code{\link[maps]{map}} is used to convert
maps data to a list, then the region names are stored in
a mutaframe created by \code{\link{qdata}}; the polygon
coordinates are stored in an attribute \code{MapData}. If
multiple polygons belong to the same upper-level region,
the column \code{labels} will store the upper-level
region names.
}
\examples{
library(cranvas)
map_qdata("state")
map_qdata("county", "iowa")
}
\author{
Yihui Xie <\url{http://yihui.name}>
}