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 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/gvisGeoMap.R
\name{gvisGeoMap}
\alias{gvisGeoMap}
\title{Google Geo Map with R
\Sexpr{googleChartName <- "geomap"}
\Sexpr{gvisChartName <- "gvisGeoMap"}}
\usage{
gvisGeoMap(data, locationvar = "", numvar = "", hovervar = "",
options = list(), chartid)
}
\arguments{
\item{data}{\code{data.frame}. The data has to have at least two
columns with location name (\code{locationvar}), value to be mapped
to location (\code{numvar}) and an optional variable to display any
text while the mouse hovers over the location (\code{hovervar}).}
\item{locationvar}{column name of \code{data} with the geo locations to be
analysed. The locations can be provide in two formats:
\describe{
\item{Format 1}{'latitude:longitude'. See the example below.}
\item{Format 2}{Address, country name, region name locations, or
US metropolitan area codes, see
\url{https://developers.google.com/adwords/api/docs/appendix/geotargeting?csw=1}.
This format works with the \code{dataMode} option set to either
'markers' or 'regions'. The following formats are accepted:
A specific address (for example, "1600 Pennsylvania Ave").
A country name as a string (for example, "England"), or an uppercase ISO-3166 code
or its English text equivalent (for example, "GB" or "United Kingdom").
An uppercase ISO-3166-2 region code name or its English text
equivalent (for example, "US-NJ" or "New Jersey").
}
}}
\item{numvar}{column name of \code{data} with the numeric value
displayed when the user hovers over this region.}
\item{hovervar}{column name of \code{data} with the additional string
text displayed when the user hovers over this region.}
\item{options}{list of configuration options.
The options are documented in detail by Google online:
% START DYNAMIC CONTENT
\Sexpr[results=rd]{gsub("CHARTNAME",
googleChartName,
readLines(file.path(".", "inst", "mansections",
"GoogleChartToolsURLConfigOptions.txt")))}
\Sexpr[results=rd]{paste(readLines(file.path(".", "inst",
"mansections", "gvisOptions.txt")))}}
\item{chartid}{character. If missing (default) a random chart id will be
generated based on chart type and \code{\link{tempfile}}}
}
\value{
\Sexpr[results=rd]{paste(gvisChartName)} returns list
of \code{\link{class}}
\Sexpr[results=rd]{paste(readLines(file.path(".", "inst",
"mansections", "gvisOutputStructure.txt")))}
}
\description{
The gvisGeoMap function reads a data.frame and
creates text output referring to the Google Visualisation API, which can be
included into a web page, or as a stand-alone page.
A geo map is a map of a country, continent, or region map, with colours
and values assigned to specific regions. Values are displayed as a colour
scale, and you can specify optional hover-text for regions. The map is
rendered in the browser. Note that the
map is not scroll-able or drag-gable, but can be configured to allow
zooming.
}
\section{Warnings}{
GeoMap (gvisGeoMap) is Flash based, conisder using GeoChart (gvisGeoChart) instead.
For more details visit: goo.gl/tkiEV8
Because of Flash security settings the chart
might not work correctly when accessed from a file location in the
browser (e.g., file:///c:/webhost/myhost/myviz.html) rather than
from a web server URL (e.g. https://www.myhost.com/myviz.html).
See the googleVis package vignette and the Macromedia web
site (\url{https://www.macromedia.com/support/documentation/en/flashplayer/help/})
for more details.
}
\examples{
## Please note that by default the googleVis plot command
## will open a browser window and requires Internet
## connection to display the visualisation.
## Regions Example
## The regions style fills entire regions (typically countries) with colors
## corresponding to the values that you assign. Specify the regions style
## by assigning options['dataMode'] = 'regions' in your code.
G1 <- gvisGeoMap(Exports, locationvar='Country', numvar='Profit',
options=list(dataMode="regions"))
plot(G1)
## Markers Example
## The "markers" style displays a circle, sized and colored to indicate
## a value, over the regions that you specify.
G2 <- gvisGeoMap(CityPopularity, locationvar='City', numvar='Popularity',
options=list(region='US', height=350,
dataMode='markers',
colors='[0xFF8747, 0xFFB581, 0xc06000]'))
plot(G2)
## Example showing US data by state
require(datasets)
states <- data.frame(state.name, state.x77)
G3 <- gvisGeoMap(states, "state.name", "Illiteracy",
options=list(region="US", dataMode="regions",
width=600, height=400))
plot(G3)
## Example with latitude and longitude information
## Show Hurricane Andrew (1992) storm track
G4 <- gvisGeoMap(Andrew, locationvar="LatLong", numvar="Speed_kt",
hovervar="Category",
options=list(height=350, region="US", dataMode="markers"))
plot(G4)
## World population
WorldPopulation=data.frame(Country=Population$Country,
Population.in.millions=round(Population$Population/1e6,0),
Rank=paste(Population$Country, "Rank:", Population$Rank))
G5 <- gvisGeoMap(WorldPopulation, "Country", "Population.in.millions", "Rank",
options=list(dataMode="regions", width=600, height=300))
plot(G5)
}
\references{
Google Chart Tools API:
\Sexpr[results=rd]{gsub("CHARTNAME",
googleChartName,
readLines(file.path(".", "inst", "mansections",
"GoogleChartToolsURL.txt")))}
% END DYNAMIC CONTENT
}
\author{
Markus Gesmann \email{markus.gesmann@gmail.com},
Diego de Castillo \email{decastillo@gmail.com}
}
\keyword{iplot}
|