siane_map: Loads a spanish map

Description Usage Arguments Details Value Examples

View source: R/siane_map.R

Description

A function that returns a S4 object(map) of a Spain specific map

Usage

1
siane_map(obj, canarias, year, level, scale, peninsula)

Arguments

obj

: Path to the Siane maps.

canarias

: A boolean value(TRUE/FALSE) to take Canarias into account.

year

: The numeric year of the maps requested.

level

: Is a string that represents the administrative level.

scale

: It's the scale of the map.

peninsula

: Parameter that specificates the layout of Canarias islands.

Details

- obj should be a string of the path to the maps. It should contain the subfolders SIANE_CARTO_BASE_S_3M and SIANE_CARTO_BASE_S_6M5.
- level can take the values of "Provincias","Municipios" or "Comunidades". The default value
is level <- "Provincias"
- canarias set to TRUE returns the Canarias map. canarias set to FALSE returns to the Peninsulae maps.
- The year variable should be numeric. If the map is not available for that year, the loaded map will be the latest available map.
The default value for the year is the latest year in which the maps are available.
- The scale of the maps can be 1:3000000 or 1:6500000. The corresponding values for the scale variable are "3m" and "6m".
The default value for the municipalities maps is scale <- "3m" . The default value for the other maps is scale <- "6m"
#' - The peninsula variable can take the values "far", "close" and "none".

Value

A S4 object specified by the user

Examples

1
2
3
4
5
## Not run: 
obj <- register_siane("/home/ncarvalho/Downloads/") # Registering a sample of Siane
shp <- siane_map(obj = obj, level = "Municipios", canarias = FALSE, peninsula = "close") 
plot(shp) # Plot the map
## End(Not run)

Nuniemsis/Siane documentation built on May 21, 2019, 2:20 p.m.