get_cities: Cities contained in Fogo Cruzado's API.

View source: R/get_cities.R

get_citiesR Documentation

Cities contained in Fogo Cruzado's API.

Description

get_cities() extracts data about cities covered by Fogo Cruzado's project, from its API (https://api.fogocruzado.org.br/). The function returns a data.frame where each observation corresponds to a city.

Usage

get_cities()

Value

A data.frame with the following variables:

  • CidadeId: internal id number of the city where the occurrence happened.

  • EstadoId: internal id number of the state where the occurrence happened.

  • Cidade: city's name.

  • CodigoIBGE: IBGE's (Brazilian Institute of Geography and Statistics) code for the city where the occurrence happened.

  • Gentilico: city's gentilic.

  • Populacao: city's population.

  • Area: city's area.

  • DensidadeDemografica: city's population density.

  • PIBPrecoCorrente: city's gross domestic product.

See Also

get_fogocruzado fogocruzado_signin

Examples

# returns a data.frame with all cities contained in the data repository

## Not run: 
cities <- get_cities()

## End(Not run)

voltdatalab/crossfire documentation built on Oct. 30, 2023, 7:11 p.m.