File: map.text.Rd

package info (click to toggle)
r-cran-maps 3.4.2.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 5,568 kB
  • sloc: ansic: 1,564; makefile: 59; awk: 21; sh: 13
file content (44 lines) | stat: -rw-r--r-- 1,580 bytes parent folder | download | duplicates (6)
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
\author{Tom Minka}
\name{map.text}
\alias{map.text}
\title{
  Draw a map with labeled regions
}
\description{
  Like \code{\link{map}}, but labels the regions.
}
\usage{
map.text(database, regions = ".", exact = FALSE, labels, cex = 0.75,
add = FALSE, move = FALSE, ...)
}
\arguments{
  \item{database}{character string naming a geographical database, or a list of
    \code{x}, \code{y}, and \code{names} obtained from a previous call to
    \code{map}.}
  \item{regions}{character vector that names the polygons to draw.}
  \item{exact}{If 'TRUE', only exact matches with 'regions' are selected
    for drawing.}
  \item{labels}{character vector of labels, one for each region
    selected.  Defaults to the names in the database.}
  \item{cex}{character expansion factor.}
  \item{add}{If \code{FALSE}, a map is drawn, then labels placed on top.  If
    \code{TRUE}, labels are added to the existing map.}
  \item{move}{If \code{TRUE}, labels are moved so that they don't
    overlap.  Requires the \code{mining} library (not in CRAN, contact
    tpminka@media.mit.edu).}
  \item{...}{Other arguments are the same as in \code{\link{map}}.}
}
\value{
  If \code{add = FALSE}, a map is drawn by calling \code{\link{map}}.
  Then the label for each region is placed at the centroid of the region
  polygon.

  The return value is a map object, as from \code{\link{map}}.
}
\examples{
map.text("world", "ira")    # iran and iraq
map.text("state", "penn")
map.text("county", "penn")  # Pennsylvania counties
map.text("county", "new jersey")  # New Jersey counties
}
\keyword{hplot}