choroplethr: admin1_choropleth – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

admin1_choropleth

Create an admin1-level choropleth for a specified country

Description

The map used comes from ?admin1.map in the choroplethrAdmin1 package. See ?get_admin_countries and ?get_admin_regions in the choroplethrAdmin1 package for help with the spelling of regions.

Usage

admin1_choropleth(
  country.name,
  df,
  title = "",
  legend = "",
  num_colors = 7,
  zoom = NULL,
  reference_map = FALSE
)

Arguments

`country.name`	The name of the country. Must exactly match how the country is named in the "country" column of ?admin1.regions in the choroplethrAdmin1 package.
`df`	A data.frame with a column named "region" and a column named "value". Elements in the "region" column must exactly match how regions are named in the "region" column in ?admin1.regions in the choroplethrAdmin1 package
`title`	An optional title for the map.
`legend`	An optional name for the legend.
`num_colors`	The number of colors on the map. A value of 1 will use a continuous scale. A value in [2, 9] will use that many colors.
`zoom`	An optional vector of regions to zoom in on. Elements of this vector must exactly match the names of regions as they appear in the "region" column of ?admin1.regions.
`reference_map`	If true, render the choropleth over a reference map from Google Maps.

Examples

## Not run: 

library(choroplethrAdmin1)

data(df_japan_census)
head(df_japan_census)
# set the value we want to map to be the 2010 population estimates
df_japan_census$value=df_japan_census$pop_2010

# default map of all of japan
admin1_choropleth("japan", 
                   df_japan_census, 
                   "2010 Japan Population Estimates", 
                   "Population")

# zoom in on the Kansai region and use a continuous scale
kansai = c("mie", "nara", "wakayama", "kyoto", "osaka", "hyogo", "shiga")
admin1_choropleth("japan", 
                   df_japan_census, 
                   "2010 Japan Population Estimates", 
                   "Population", 
                   1, 
                   kansai)
                   
admin1_choropleth("japan", 
                   df_japan_census, 
                   "2010 Japan Population Estimates", 
                   "Population", 
                   1, 
                   kansai,
                   reference_map = TRUE)

## End(Not run)

choroplethr

Simplify the Creation of Choropleth Maps in R

v3.7.0

BSD_3_clause + file LICENSE

Authors

Ari Lamstein [aut, cre], Brian Johnson [ctb], Trulia, Inc. [cph]

Initial release