Skip to contents

Get Brazilian state names

Source: R/get_brazil_state.R
get_brazil_state.Rd

get_brazil_state() returns a vector with the names of Brazilian states.

Usage

get_brazil_state(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 state names (default: NULL).

Value

A character vector with the names of Brazilian states.

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_municipality_coords(), get_brazil_municipality_latitude(), get_brazil_municipality_longitude(), get_brazil_region(), get_brazil_region_code(), 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_state()
#>  [1] "Acre"                "Alagoas"             "Amapá"              
#>  [4] "Amazonas"            "Bahia"               "Ceará"              
#>  [7] "Distrito Federal"    "Espírito Santo"      "Goiás"              
#> [10] "Maranhão"            "Mato Grosso"         "Mato Grosso do Sul" 
#> [13] "Minas Gerais"        "Pará"                "Paraíba"            
#> [16] "Paraná"              "Pernambuco"          "Piauí"              
#> [19] "Rio de Janeiro"      "Rio Grande do Norte" "Rio Grande do Sul"  
#> [22] "Rondônia"            "Roraima"             "Santa Catarina"     
#> [25] "São Paulo"           "Sergipe"             "Tocantins"          

get_brazil_state("rj")
#> [1] "Rio de Janeiro"
#> [1] "Rio de Janeiro" # Expected

get_brazil_state("rio de janeiro")
#> [1] "Rio de Janeiro"
#> [1] "Rio de Janeiro" # Expected

get_brazil_state(33)
#> [1] "Rio de Janeiro"
#> [1] "Rio de Janeiro" # Expected

get_brazil_state(3302700) # Maricá
#> [1] "Rio de Janeiro"
#> [1] "Rio de Janeiro" # Expected

get_brazil_state(33027001) # >7 digits
#> [1] NA
#> [1] NA # Expected

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

get_brazil_state("southeast")
#> [1] "Espírito Santo" "Minas Gerais"   "Rio de Janeiro" "São Paulo"     
#> [1] "Espírito Santo" "Minas Gerais"   "Rio de Janeiro" # Expected
#> [4] "São Paulo"

get_brazil_state(3)
#> [1] "Espírito Santo" "Minas Gerais"   "Rio de Janeiro" "São Paulo"     
#> [1] "Espírito Santo" "Minas Gerais"   "Rio de Janeiro" # Expected
#> [4] "São Paulo"