read_metro_area: Download spatial data of official metropolitan areas in...

View source: R/read_metro_area.R

read_metro_areaR Documentation

Download spatial data of official metropolitan areas in Brazil

Description

The function returns the shapes of municipalities grouped by their respective metro areas. Metropolitan areas are created by each state in Brazil. The data set includes the municipalities that belong to all metropolitan areas in the country according to state legislation in each year. Original data were generated by Institute of Geography. Data at scale 1:250,000, using Geodetic reference system "SIRGAS2000" and CRS(4674).

Usage

read_metro_area(year = 2018, simplified = TRUE, showProgress = TRUE)

Arguments

year

A year number in YYYY format. Defaults to 2018

simplified

Logic FALSE or TRUE, indicating whether the function should return the data set with 'original' spatial resolution or a data set with 'simplified' geometry. Defaults to TRUE. For spatial analysis and statistics users should set simplified = FALSE. Borders have been simplified by removing vertices of borders using st_simplify{sf} preserving topology with a dTolerance of 100.

showProgress

Logical. Defaults to TRUE display progress bar.

Value

An "sf" "data.frame" object

Examples

## Not run:  if (interactive()) {
# Read all official metropolitan areas for a given year
  m <- read_metro_area(2005)

  m <- read_metro_area(2018)
}
## End(Not run)

geobr documentation built on Aug. 16, 2022, 9:05 a.m.