WR {mapping} | R Documentation |
Object of class WR
Description
Creates an object with data and coordinate of class WR
to use with mapping
function or available in other R "maps" packages.
Usage
WR(data, colID = NULL,
unit = c("country", "nato", "ocde", "continent",
"region", "subregion", "region_wb",
"type_income", "type_economy"),
matchWith = c("country", "iso2", "iso3", "iso3_eh",
"iso3_numeric", "iso3_un", "iso2_wb",
"iso3_wb", "name_formal", "name_wb"),
res = c("low", "hi"), show_wr = TRUE, subset = NULL,
add = NULL, new_var_names = NULL,
aggregation_fun = sum, aggregation_unit = NULL, aggregation_var = NULL,
facets = NULL, check.unit.names = TRUE, dir = NULL, use_cache = TRUE,
print = FALSE, use_internet = TRUE, crs = NULL)
Arguments
data |
a data.frame object with variables to display | ||||||||||||||||||||
colID |
character value or columns number indicating the column with unit names | ||||||||||||||||||||
unit |
the type of world statistical unit | ||||||||||||||||||||
matchWith |
the type of id to check:
| ||||||||||||||||||||
res |
map resolution | ||||||||||||||||||||
show_wr |
logical value set to TRUE indicating if the entire map is drawn or only the coordinates linked to the input data | ||||||||||||||||||||
subset |
a formula indicating the condition to subset the data, see the Details | ||||||||||||||||||||
add |
a formula to add new transformed variables starting from the variables in the | ||||||||||||||||||||
new_var_names |
a character value or vector indicating the names of the new variables created in | ||||||||||||||||||||
aggregation_fun |
function to use when data are aggregated | ||||||||||||||||||||
aggregation_unit |
variable name by which the unit are aggregated | ||||||||||||||||||||
aggregation_var |
variable name with value to aggregate | ||||||||||||||||||||
facets |
variable(s) name to split the data | ||||||||||||||||||||
check.unit.names |
a logical value indicating if the | ||||||||||||||||||||
dir |
local directory in which shape files are stored | ||||||||||||||||||||
use_cache |
a logical value indicating whether use the cache | ||||||||||||||||||||
print |
a logical value indicating whether print the nomatched names | ||||||||||||||||||||
use_internet |
a logical value indicating wheter the coordinates are downloaded from https://github.com/mappinguniverse/geospatial. If | ||||||||||||||||||||
crs |
coordinate reference system. Look at |
Details
The function links (automatically) the id in the data
and the coordinates for the given unit
.
Since the names (or codes) provided in the data
given in input must be checked with the unit
names (or codes) available in the package, the check.unit.names
provides a preliminary check.
subset
provide an expression to subset the data
, using a formula with the logical operators. For example, sub-samples of the data can be selected as follows: ~I("Variable 1" == "condition 1" & "Variable 2" != "condition 2")
or for example, ~I("Variable 1" > "condition 1" | "Variable 2" != "condition 2")
.
Value
An object of class WR
, with data and coordinates to use in functions which perform map.
See Also
Examples
data("popWR")
wr <- WR(data = popWR, colID = "country_code",
matchWith = "iso3_eh", res = "low")
str(wr, 1)
wr1 <- WR(data = popWR, colID = "country_code",
matchWith = "iso3_eh", res = "low",
add = ~I(male/total) + I(female/total))
str(wr1)
wr2 <- WR(data = popWR, colID = "country_code",
matchWith = "iso3_eh", res = "low",
add = ~I(male/total) + I(female/total),
new_var_names = c("Per_Male", "Per_Female"))
str(wr2)