mapCirclesChoro: Proportional Circles Colored by a Discretized Quantitative...

In rCarto: This package builds maps with a full cartographic layout.

Description

This function represents two variables through a proportional circles map. The areas of the circles are proportional to values of a quantitative variable and their colors reflect the discretization of an other numeric variable.

Usage

mapCirclesChoro(shpFile, shpId, df, dfId, var, var2, 
                fixedNorm = FALSE, shareOfCircles = 0.02, 
                radiusMax = 0.5, valueMax = max(df[, var], na.rm = TRUE), 
                lgdRndCircles = 0, posLegCircles = "topright", 
                circleCol = "grey", baseCol = "#FFEDA0", 
                nclass = 6, style = "quantile", fixBrks = FALSE, listBrks = NULL, 
                diverg = FALSE, divergBrk = 0, 
                palCol = "Greens", palColPos = "Reds", palColNeg = "Blues", 
                NACol = "grey",
                lgdRndDistr = 2, posLegDistr = "bottomleft", 
                title = paste(var, var2, sep = " & "), 
                legendCircles = var, legendDistr = var2, 
                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 variables to be mapped.
dfId	Unique identifier of the data frame. It must correspond to shpId.
var	Name of the positive numeric variable to be mapped through the sizes of the circles.
var2	Name of the positive numeric variable to be mapped through the colors of the circles.
fixedNorm	FALSE (default) : the sum of the surfaces occupied by circles is proportional to the size of the map and is declared by the shareOfCircles argument, radiusMax and valueMax are not used. TRUE : the size of the largest circle is defined by a radius size (radiusMax) and a fixed variable value (valueMax), the shareOfCircles argument is not used.
shareOfCircles	Share of the surface of the map occupied by circles (0.02 is 2%).
radiusMax	Size (in cm) of the radius of the biggest circle.
valueMax	Value used to normalize the size of the largest circle (in variable units).
lgdRndCircles	Rounding of the values of the variable presented in the legend of the circles.
posLegCircles	Position of the legend of the circles(top, bottom, left, right, center, topleft, topright, bottomleft or bottomright).
circleCol	Color of the circles in the legend
baseCol	Color of the base map.
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 used.
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 values superior to the divergBrk value and inferior to the divergBrk value.
divergBrk	Value used to define the break in the color palette if diverg=TRUE.
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).
lgdRndDistr	Rounding of the class intervals presented in the legend.
posLegDistr	Position of the legend of the discretization (top, bottom, left, right, center, topleft, topright, bottomleft or bottomright).
title	Title of the map.
legendCircles	Title of the legend for the circles
legendDistr	Title of the legend for the discretization
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.

Details

The circles are centered on the centroids of the polygons.
Only the six first arguments are compulsory.

Value

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

Author(s)

Timothee Giraud - UMS RIATE (CNRS)

See Also

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
mapCirclesChoro(shpFile=file.path(path.package("rCarto"), "shapes/COMMUNE"),
                shpId="INSEE_COM",df=mtq,dfId="ID",var="P09_POP",var2="POPVAR")

rCarto documentation built on May 2, 2019, 8:20 a.m.