Skip to contents

Get Brazilian federative unit abbreviations

Source: R/get_brazil_fu.R
get_brazil_fu.Rd

get_brazil_fu() returns a vector with the abbreviations of Brazilian federal units.

Usage

get_brazil_fu(x = NULL)

Arguments

x

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

Value

A character vector with the abbreviations of Brazilian federal units.

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_municipality(), get_brazil_municipality_code(), get_brazil_region(), 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_fu()
#>  [1] "AC" "AL" "AP" "AM" "BA" "CE" "DF" "ES" "GO" "MA" "MT" "MS" "MG" "PA" "PB"
#> [16] "PR" "PE" "PI" "RJ" "RN" "RS" "RO" "RR" "SC" "SP" "SE" "TO"

get_brazil_fu("sp")
#> [1] "SP"
#> [1] "SP" # Expected

get_brazil_fu("sao paulo")
#> [1] "SP"
#> [1] "SP" # Expected

get_brazil_fu(35)
#> [1] "SP"
#> [1] "SP" # Expected

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

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

get_brazil_fu(39027001) # Non-existent state code
#> [1] NA
#> [1] NA # Expected

get_brazil_fu("southeast")
#> [1] "ES" "MG" "RJ" "SP"
#> [1] "ES" "MG" "RJ" "SP" # Expected

get_brazil_fu(3)
#> [1] "ES" "MG" "RJ" "SP"
#> [1] "ES" "MG" "RJ" "SP" # Expected