rCarto (version 0.8)

mapChoropleth: Choropleth

Description

This function represents a numeric variable through a choropleth map.

Usage

mapChoropleth(shpFile, shpId, df, dfId, var, 
              nclass = 6, style = "quantile", 
              fixBrks = FALSE, listBrks = NULL, diverg = FALSE, divergBrk = 0, 
              lgdRnd = 2, posLeg = "bottomleft", 
              palCol = "Greens", palColPos = "Reds", palColNeg = "Blues", 
              NACol = "grey",
              title = var, legend = var, author = "author", sources = "sources", 
              scalebar = FALSE, scalebarSize, scalebarText, 
              northArrow = FALSE, northArrowSize, 
              width = NULL, height = NULL, txtCex = NULL)

Arguments

shpFile

Path to a polygon shapefile.

shpId

Unique identifier of the shapefile. It must correspond to dfId.

df

Data frame that contains the variable to be mapped.

dfId

Unique identifier of the data frame. It must correspond to shpId.

var

Name of the numeric variable to be mapped.

nclass

Number of classes to be represented.

style

Method used to provide the class intervals. See style in the classIntervals function from the classInt package.

fixBrks

FALSE (default): the class intervals are computed through the style argument. TRUE : the class intervals are provided through the listBrks argument, nclass and style are not use

listBrks

Vector of values used as breaks for the class intervals when fixBrks = TRUE.

diverg

FALSE (default): there is no color break in the color palette. TRUE : a break is introduced in the color palette. Palettes are defined through the palColPos and palColNeg arguments, respectively for valu

divergBrk

Value used to define the break in the color palette if diverg=TRUE.

lgdRnd

Rounding of the class intervals presented in the legend.

posLeg

Position of the legend (top, bottom, left, right, center, topleft, topright, bottomleft or bottomright).

palCol

Color palette, provided through RColorBrewer, to be used in the map. Use display.brewer.all() to see the available color ramps. For a more detailed overview : RColorBrewer.

palColPos

Palette used for values superior to divergBrk if diverg=TRUE. See palCol for details.

palColNeg

Palette used for values inferior to divergBrk if diverg=TRUE. See palCol for details.

NACol

Color used to draw units with no data (NA).

title

Title of the map.

legend

Title of the legend.

author

Two lines (author and sources) at the bottom of the map are available to display additional information. It is recommended to display the name of the author and the sources of the data and the base map.

sources

Two lines (author and sources) at the bottom of the map are available to display additional information. It is recommended to display the name of the author and the sources of the data and the base map.

scalebar

FALSE (default): don't draw a scale bar. TRUE : draws a scale bar. The choice of the scale bar location is interactive.

scalebarSize

Size of the scale bar in map units.

scalebarText

Text of the scale bar.

northArrow

FALSE (default) : don't draw a North arrow. TRUE : draws a North arrow. The choice of the North arrow location is interactive.

northArrowSize

Size of the North arrow in map units.

width

Width of the map in cm.

height

Height of the map in cm.

txtCex

Size of the texts.

Value

• A choropleth map is displayed in the graphic window. You can export the map in raster or vector format (pdf).

Details

Only the five first arguments are compulsory.

See Also

ll{ rCarto-package rCarto package mapCircles proportional circles mapCirclesChoro proportional circles colored by a discretized quantitative variable mapCirclesTypo proportional circles colored by the modalities of a qualitative variable mapChoropleth choropleth mapChoroTypo typology mtq data commune shapefile }

Examples

library(rCarto)
data(mtq)
# minimal example
mtq$POPVAR <- (mtq$P09_POP-mtq$P99_POP) / mtq$P99_POP
mapChoropleth(shpFile=file.path(path.package("rCarto"), "shapes/COMMUNE"),
              shpId="INSEE_COM",df=mtq,dfId="ID",var="POPVAR")
# detailed example
mtq$POPVAR[3] <- NA
mapChoropleth(shpFile=file.path(path.package("rCarto"), "shapes/COMMUNE"), 
              shpId="INSEE_COM",df=mtq,dfId="ID",var="POPVAR",
              nclass=6,style="quantile",
              diverg=TRUE,divergBrk=0,
              lgdRnd=2,posLeg="bottomleft",
              palColPos="Greens",palColNeg="Blues",NACol="grey",
              title="Population growth in Martinique",
              legend="Population growth
rate between
1999 and 2009",
              author=Sys.getenv("USERNAME"),
              sources="data : INSEE,2009; basemap : IGN, 2012")