mapCirclesTypo: Proportionnal Circles Colored by the Modalities of a...

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/mapCirclesTypo.R

Description

This function represents two variables through a proportional circles map. The areas of the circles are proportional to values in a quantitative variable and their colors reflect a the modalities of a qualitative variable.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
mapCirclesTypo(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", 
               posLegTypo = "bottomleft", palCol = "Paired", NACol = "grey", 
               title = paste(var, var2, sep = " & "), 
               legendCircles = var, legendTypo = 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 qualitative variable to be mapped.

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.

posLegTypo

Position of the legend of the typology (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.

NACol

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

title

Title of the map.

legendCircles

Title of the legend for the circles

legendTypo

Title of the legend for the typology

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

1
2
3
4
5
6
7
8
9
library(rCarto)
data(mtq)

# minimal example
mtq[c(1,12,18,23,33,8,24),"beach"] <- "No access to the beach"
mtq[c(2,4,5,6,9,13,17,20,21,25,26,29,31,34,11,27,7,19),"beach"] <- "Caribbean Sea"
mtq[c(14,15,16,22,28,30,32,10,3),"beach"] <- "Atlantic Ocean"
mapCirclesTypo(shpFile=file.path(path.package("rCarto"), "shapes/COMMUNE"),
              shpId="INSEE_COM",df=mtq,dfId="ID",var="P09_POP",var2="beach")              

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