| Title: | Acesso aos Dados do 'SIDRA' do IBGE |
|---|---|
| Description: | Functions for accessing and manipulating data from Brazilian Institute of Geography and Statistics (IBGE)'s API 'SIDRA' (acronym for IBGE System of Automatic Retrieval) from the new endpoints at <https://servicodados.ibge.gov.br/api/docs/agregados?versao=3>. Ferramentas para acessar e manipular dados via API do Sistema IBGE De Recuperação Automática 'SIDRA' do Instituto Brasileiro de Geografia e Estatística (IBGE). |
| Authors: | Rodrigo Emmanuel Santana Borges [cre, aut, cph] (affiliation - Distintive Lab & UnDF) |
| Maintainer: | Rodrigo Emmanuel Santana Borges <[email protected]> |
| License: | GPL-3 |
| Version: | 0.2.0 |
| Built: | 2026-10-04 07:15:14 UTC |
| Source: | https://github.com/rodrigoesborges/sidra |
Para utilização inicial, base com todos agregados disponíveis
data(agregados)data(agregados)
An object of class tbl_df (inherits from tbl, data.frame) with 6 rows and 3 columns.
data(agregados)data(agregados)
Esta função retorna a tabela solicitada em formato data.frame.
sidra( tabela, classificador = "", filtro_cats = "", nivel = "N1", filtro_niveis, periodo = tab_meta(tabela)$periodos, variavel = "all", inicio, fim, part = FALSE, printurl = FALSE )sidra( tabela, classificador = "", filtro_cats = "", nivel = "N1", filtro_niveis, periodo = tab_meta(tabela)$periodos, variavel = "all", inicio, fim, part = FALSE, printurl = FALSE )
tabela |
Número da tabela. |
classificador |
Classificador a ser detalhado. O padrão é "", retornando os totais da tabela. Para verificar os classificadores disponíveis na tabela em questão use a função tab_class(). |
filtro_cats |
Código para definição de subconjunto do classificador. Para verificar as categorias disponíveis na tabela em questão use a função tab_class(). |
nivel |
Nível geográfico de agregação dos dados 1 = Brasil e 6 = Município, etc. Para verificar os níveis disponíveis na tabela em questão use a função tab_niveis(). |
filtro_niveis |
Código contendo conjunto no nível que será selecionado. Pode-se usar o código de determina UF para obter apenas seus dados ou "all" para todos (padrão). Para mais informações visite http://api.sidra.ibge.gov.br/home/ajuda. |
periodo |
Período dos dados. O padrão é "all", isto é, todos os anos disponíveis. Para verificar os períodos disponíveis na tabela em questão use a função tab_periodos(). |
variavel |
Quais variáveis devem retornar? O padrão é "allxp", isto é, todas exceto aquelas calculadas pela SIDRA (percentuais). Para verificar as variáveis disponíveis na tabela em questão use a função tab_vars(). |
inicio, fim
|
Início e fim do período desejado. |
part |
interno para quando é preciso fazer várias requisições |
printurl |
imprime url construído para transparência e debugging |
Um 'data.frame' ('tibble') contendo os dados solicitados da tabela SIDRA. A estrutura do data.frame está em formato amplo (wide),
onde cada linha geralmente corresponde a um nível geográfico e período de tempo específico. As colunas incluem detalhes sobre a localidade, o período e as variáveis,
com as categorias de classificação transformadas em colunas separadas.
ipcaq <- sidra(1705,classificador=315,periodo='201202')ipcaq <- sidra(1705,classificador=315,periodo='201202')
Para utilização inicial, base com todos agregados disponíveis
data(agregados) data(sidrameta)data(agregados) data(sidrameta)
An object of class data.table (inherits from data.frame) with 21470 rows and 4 columns.
data(sidrameta)data(sidrameta)
Esta função retorna uma lista com Todas as tabelas para agregado indicado
tab_agr(agregado)tab_agr(agregado)
agregado |
Número do agregado. |
Uma lista contendo dois 'data.table's:
pesquisas: Um 'data.table' com o ID e o nome das pesquisas relacionadas.
tabelas: Um 'data.table' com o ID e o nome das tabelas (agregados) disponíveis para a consulta indicada.
tabs_a70 <- tab_agr('A70') tab_agr('A70') # imprime os agregados com sua descriçãotabs_a70 <- tab_agr('A70') tab_agr('A70') # imprime os agregados com sua descrição
Esta função retorna uma lista com classificadores de uma das tabelas da SIDRA.
tab_class(tabela)tab_class(tabela)
tabela |
Número da tabela. |
uma lista de 'data.frame's, onde cada um representa um classificador e suas categorias.
class_ipcaq <- tab_class(1705) tab_class(1705) # imprime os classificadores com sua descriçãoclass_ipcaq <- tab_class(1705) tab_class(1705) # imprime os classificadores com sua descrição
Esta função retorna a fonte de uma das tabelas da SIDRA.
tab_fonte(tabela)tab_fonte(tabela)
tabela |
Número da tabela. |
uma 'string' (vetor de caracteres de comprimento 1) com o nome da fonte dos dados da tabela solicitada
fonte_ipcaq <- tab_fonte(1705) tab_fonte(1705) # imprime o nome da fontefonte_ipcaq <- tab_fonte(1705) tab_fonte(1705) # imprime o nome da fonte
Esta função retorna uma lista com os ids e o conteúdo da descrição da tabela solicitada.
tab_meta(tabela)tab_meta(tabela)
tabela |
Número da tabela. |
Uma 'lista' contendo os metadados da tabela solicitada. A lista inclui elementos como:
nivelTerritorial: um vetor com os níveis territoriais disponíveis.
variaveis: um 'data.frame' com as variáveis da tabela.
periodos: um vetor com os períodos disponíveis.
classificacoes: uma lista de 'data.frame's, onde cada um representa um classificador e suas categorias.
Outros metadados diversos da tabela, como nome, pesquisa, assunto, etc.
meta_ipcaq <- tab_meta(1705)meta_ipcaq <- tab_meta(1705)
Esta função retorna uma lista com níveis territoriais disponíveis de uma das tabelas da SIDRA.
tab_niveis(tabela)tab_niveis(tabela)
tabela |
Número da tabela. |
Um 'data.frame' (especificamente, um 'data.table') que lista todas as localidades disponíveis para a tabela, detalhando o ID e o nome de cada localidade, bem como o ID e o nome do nível geográfico correspondente (ex: 'N3' para "Unidade da Federação").
niveis_ipca15 <- tab_niveis(1705) tab_niveis(1705) # imprime os níveis territoriais da tabela solicitadaniveis_ipca15 <- tab_niveis(1705) tab_niveis(1705) # imprime os níveis territoriais da tabela solicitada
Esta função retorna uma lista com periodos de uma das tabelas da SIDRA.
tab_periodos(tabela)tab_periodos(tabela)
tabela |
Número da tabela. |
um vetor 'integer' ou 'character' com os períodos disponíveis da tabela solicitada
periodos_ipcaq <- tab_periodos(1705) tab_periodos(1705) # imprime os períodos disponíveis da tabelaperiodos_ipcaq <- tab_periodos(1705) tab_periodos(1705) # imprime os períodos disponíveis da tabela
Esta função retorna uma lista com agregados, tabelas ou variáveis da SIDRA que possuem o termo buscado.
tab_search(termo)tab_search(termo)
termo |
Termo a buscar. |
um 'data.frame' (especificamente um 'data.table') com as colunas:
id: um vetor com os ids das tabelas em que termo encontrado
literal: o texto onde ocorreu match
agregacao: codigo string da agregação, cf. 'tab_agr()'.
tabs_ipca <- tab_search('IPCA15') tab_search('IPCA15') # imprime tabelas/agregados/variáveis com o termo pesquisado.tabs_ipca <- tab_search('IPCA15') tab_search('IPCA15') # imprime tabelas/agregados/variáveis com o termo pesquisado.
Esta função retorna uma lista com variáveis de uma das tabelas da SIDRA.
tab_vars(tabela)tab_vars(tabela)
tabela |
Número da tabela. |
um 'data.frame' ('data.table') com as seguintes colunas:
id: ids dos indicadores
nome: nome dos indicadores
unidade: unidade de medida do indicador.
sumarizacao: tipo de agregação.
vars_ipcaq <- tab_vars(1705) tab_vars(1705) # imprime os classificadores com sua descriçãovars_ipcaq <- tab_vars(1705) tab_vars(1705) # imprime os classificadores com sua descrição