Skip to contents

Get Brazilian regions

Source: R/get_brazil_region.R
get_brazil_region.Rd

get_brazil_region() returns a vector with the names of Brazilian regions.

Usage

get_brazil_region(x = NULL)

Arguments

x

(optional) An atomic vector containing the names, abbreviations, or numeric codes of Brazilian states or federal units. Region and municipality codes are also supported. If NULL, returns a vector with all Brazilian regions. (default: NULL)

Value

A character vector with the names of Brazilian regions.

Details

The data from this function is based on data from the Brazilian Institute of Geography and Statistics (IBGE, n.d.).

References

Instituto Brasileiro de Geografia e Estatística. (n.d.). Território [Territory] [Dataset]. SIDRA. https://sidra.ibge.gov.br/territorio

See also

Other Brazil functions: get_brazil_fu(), get_brazil_municipality(), get_brazil_municipality_code(), get_brazil_region_code(), get_brazil_state(), get_brazil_state_by_utc(), get_brazil_state_capital(), get_brazil_state_code(), get_brazil_state_latitude(), get_brazil_state_longitude(), render_brazil_address()

Examples

get_brazil_region()
#> [1] "North"        "Northeast"    "South"        "Southeast"    "Central-West"
#> [1] "North" "Northeast" "South" "Southeast" "Central-West" # Expected

get_brazil_region("sp")
#> [1] "Southeast"
#> [1] "Southeast" # Expected

get_brazil_region("sao paulo")
#> [1] "Southeast"
#> [1] "Southeast" # Expected

get_brazil_region(c(1, 4))
#> [1] "North" "South"
#> [1] "North" "South" # Expected

get_brazil_region(35) # State of São Paulo
#> [1] "Southeast"
#> [1] "Southeast" # Expected

get_brazil_region(3550308) # Municipality of São Paulo
#> [1] "Southeast"
#> [1] "Southeast" # Expected

get_brazil_region(35503081) # >7 digits
#> [1] NA
#> [1] NA # Expected