Help for package sidra

Type:

Package

Title:

Acesso aos Dados do 'SIDRA' do IBGE

Version:

0.1.7

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).

License:

GPL-3

Language:

pt-BR

Encoding:

UTF-8

LazyData:

true

Imports:

httr,data.table,tidyr,dplyr,jsonlite,tibble

Depends:

R (≥ 4.1.0)

RoxygenNote:

7.3.2

Suggests:

knitr, rmarkdown, testthat (≥ 3.0.0)

Config/testthat/edition:

VignetteBuilder:

knitr

URL:

https://github.com/rodrigoesborges/sidra

BugReports:

https://github.com/rodrigoesborges/sidra/issues

NeedsCompilation:

Packaged:

2025-08-21 20:16:32 UTC; borges

Author:

Rodrigo Emmanuel Santana Borges [cre, aut, cph] (affiliation - Distintive Lab & UnDF)

Maintainer:

Rodrigo Emmanuel Santana Borges <rodrigo@borges.net.br>

Repository:

CRAN

Date/Publication:

2025-08-27 12:00:09 UTC

API servicodados.ibge ... Todos agregados disponíveis

Description

Para utilização inicial, base com todos agregados disponíveis

Usage

data(agregados)

Format

An object of class tbl_df (inherits from tbl, data.frame) with 6 rows and 3 columns.

Source

IBGE API

Examples

data(agregados)

coleta de dados via API SIDRA - IBGE

Description

Esta função retorna a tabela solicitada em formato data.frame.

Usage

sidra(
  tabela,
  classificador = "",
  filtro_cats = "",
  nivel = "N1",
  filtro_niveis,
  periodo = tab_meta(tabela)$periodos,
  variavel = "all",
  inicio,
  fim,
  part = FALSE,
  printurl = TRUE
)

Arguments

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

Value

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.

Examples

ipcaq <- sidra(1705,classificador=315,periodo='201202')

API servicodados.ibge ... Todos agregados disponíveis

Description

Para utilização inicial, base com todos agregados disponíveis

Usage

data(agregados)

data(sidrameta)

Format

An object of class data.table (inherits from data.frame) with 21470 rows and 4 columns.

Source

IBGE API

Examples

data(sidrameta)

Obtenção de tabelas por agregado via API SIDRA - IBGE

Description

Esta função retorna uma lista com Todas as tabelas para agregado indicado

Usage

tab_agr(agregado)

Arguments

agregado

Número do agregado.

Value

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.

Examples

tabs_a70 <- tab_agr('A70')
tab_agr('A70') # imprime os agregados com sua descrição

Obtenção de dados via API SIDRA - IBGE

Description

Esta função retorna uma lista com classificadores de uma das tabelas da SIDRA.

Usage

tab_class(tabela)

Arguments

tabela

Número da tabela.

Value

uma lista de 'data.frame's, onde cada um representa um classificador e suas categorias.

Examples

class_ipcaq <- tab_class(1705)
tab_class(1705) # imprime os classificadores com sua descrição

Obtenção de dados via API SIDRA - IBGE

Description

Esta função retorna a fonte de uma das tabelas da SIDRA.

Usage

tab_fonte(tabela)

Arguments

tabela

Número da tabela.

Value

uma 'string' (vetor de caracteres de comprimento 1) com o nome da fonte dos dados da tabela solicitada

Examples

fonte_ipcaq <- tab_fonte(1705)
tab_fonte(1705) # imprime o nome da fonte

Obtenção de dados via API SIDRA - IBGE

Description

Esta função retorna uma lista com os ids e o conteúdo da descrição da tabela solicitada.

Usage

tab_meta(tabela)

Arguments

tabela

Número da tabela.

Value

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.

Examples

meta_ipcaq <- tab_meta(1705)

Obtenção de dados via API SIDRA - IBGE

Description

Esta função retorna uma lista com níveis territoriais disponíveis de uma das tabelas da SIDRA.

Usage

tab_niveis(tabela)

Arguments

tabela

Número da tabela.

Value

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").

Examples

niveis_ipca15 <- tab_niveis(1705)
tab_niveis(1705) # imprime os níveis territoriais da tabela solicitada

Obtenção de dados via API SIDRA - IBGE

Description

Esta função retorna uma lista com periodos de uma das tabelas da SIDRA.

Usage

tab_periodos(tabela)

Arguments

tabela

Número da tabela.

Value

um vetor 'integer' ou 'character' com os períodos disponíveis da tabela solicitada

Examples

periodos_ipcaq <- tab_periodos(1705)
tab_periodos(1705) # imprime os períodos disponíveis da tabela

Busca de tabelas/agregados ou variáveis via API SIDRA - IBGE

Description

Esta função retorna uma lista com agregados, tabelas ou variáveis da SIDRA que possuem o termo buscado.

Usage

tab_search(termo)

Arguments

termo

Termo a buscar.

Value

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()'.

Examples

tabs_ipca <- tab_search('IPCA15')
tab_search('IPCA15') # imprime tabelas/agregados/variáveis com o termo pesquisado.

Obtenção de dados via API SIDRA - IBGE

Description

Esta função retorna uma lista com variáveis de uma das tabelas da SIDRA.

Usage

tab_vars(tabela)

Arguments

tabela

Número da tabela.

Value

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.

Examples

vars_ipcaq <- tab_vars(1705)
tab_vars(1705) # imprime os classificadores com sua descrição