Get Brazilian regions

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

Usage

get_brazil_region(x = NULL)

Arguments

x

(Optional) A character vector with the names of Brazilian states or federal unit abbreviations. If NULL, returns 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_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] "Central-West" "North"        "Northeast"    "South"        "Southeast"   
#> [1] "Central-West" "North" "Northeast" "South" "Southeast" # Expected

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

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