Introduction to sidrar

Renato Prado Siqueira

2021-07-30

R Interface to the SIDRA’s API

The “sidrar” R package seeks to provide direct access to the data of SIDRA - Sistema IBGE de Recuperação Automática - within the R environment in an easy and flexible way.

Installation

To install the version available on CRAN:

install.packages("sidrar")

To install the development version hosted on Github:

library(devtools)
install_github("rpradosiqueira/sidrar")

Functions

For the time being, the “sidra” package contains only three functions:

get_sidra          It recovers data from the given table
                   according to the parameters

info_sidra         It allows you to check what parameters
                   are available for a table via an web browser
                   
search_sidra       It searches which tables have a particular 
                   word in their names

Examples

get_sidra

  1. Let’s assume that we want the IPCA (Índice de Preços ao Consumidor Amplo) for the city of Campo Grande/MS. However, we will only recover the overall percentage rate in the last 12 months. To do this simply execute:
library(sidrar)

get_sidra(x = 1419,
          variable = 63,
          period = c("last" = 12),
          geo = "City",
          geo.filter = 5002407,
          classific = "c315",
          category = list(7169),
          header = FALSE,
          format = 3)
#>    NC        NN MN     V     D1C               D1N            D2N
#> 1   6 Município  %  0.20 5002704 Campo Grande (MS)   janeiro 2019
#> 2   6 Município  %  0.52 5002704 Campo Grande (MS) fevereiro 2019
#> 3   6 Município  %  0.70 5002704 Campo Grande (MS)     março 2019
#> 4   6 Município  %  0.52 5002704 Campo Grande (MS)     abril 2019
#> 5   6 Município  %  0.42 5002704 Campo Grande (MS)      maio 2019
#> 6   6 Município  %  0.18 5002704 Campo Grande (MS)     junho 2019
#> 7   6 Município  % -0.01 5002704 Campo Grande (MS)     julho 2019
#> 8   6 Município  % -0.21 5002704 Campo Grande (MS)    agosto 2019
#> 9   6 Município  % -0.04 5002704 Campo Grande (MS)  setembro 2019
#> 10  6 Município  %  0.31 5002704 Campo Grande (MS)   outubro 2019
#> 11  6 Município  %  0.65 5002704 Campo Grande (MS)  novembro 2019
#> 12  6 Município  %  1.32 5002704 Campo Grande (MS)  dezembro 2019
#>                       D3N          D4N
#> 1  IPCA - Variação mensal Índice geral
#> 2  IPCA - Variação mensal Índice geral
#> 3  IPCA - Variação mensal Índice geral
#> 4  IPCA - Variação mensal Índice geral
#> 5  IPCA - Variação mensal Índice geral
#> 6  IPCA - Variação mensal Índice geral
#> 7  IPCA - Variação mensal Índice geral
#> 8  IPCA - Variação mensal Índice geral
#> 9  IPCA - Variação mensal Índice geral
#> 10 IPCA - Variação mensal Índice geral
#> 11 IPCA - Variação mensal Índice geral
#> 12 IPCA - Variação mensal Índice geral


  1. In this example we will download the Gini index data for the 2014 GDP of the states, containing only the codes in the table (format = 1):
get_sidra(x = 5939,
          variable = 529,
          period = "2014",
          geo = "State",
          header = TRUE,
          format = 1)
#> Considering all categories once 'classific' was set to 'all' (default)
#>    Nível Territorial (Código) Unidade de Medida (Código)    Valor
#> 2                           3                         50 0.693490
#> 3                           3                         50 0.709874
#> 4                           3                         50 0.874176
#> 5                           3                         50 0.746509
#> 6                           3                         50 0.727915
#> 7                           3                         50 0.773062
#> 8                           3                         50 0.710743
#> 9                           3                         50 0.729936
#> 10                          3                         50 0.779105
#> 11                          3                         50 0.792580
#> 12                          3                         50 0.801773
#> 13                          3                         50 0.788873
#> 14                          3                         50 0.801308
#> 15                          3                         50 0.746158
#> 16                          3                         50 0.730495
#> 17                          3                         50 0.778020
#> 18                          3                         50 0.825613
#> 19                          3                         50 0.769294
#> 20                          3                         50 0.825656
#> 21                          3                         50 0.873122
#> 22                          3                         50 0.784089
#> 23                          3                         50 0.764030
#> 24                          3                         50 0.783839
#> 25                          3                         50 0.692664
#> 26                          3                         50 0.707444
#> 27                          3                         50 0.795816
#>    Unidade da Federação (Código) Ano (Código) Variável (Código)
#> 2                             11         2014               529
#> 3                             12         2014               529
#> 4                             13         2014               529
#> 5                             14         2014               529
#> 6                             15         2014               529
#> 7                             16         2014               529
#> 8                             17         2014               529
#> 9                             21         2014               529
#> 10                            22         2014               529
#> 11                            23         2014               529
#> 12                            24         2014               529
#> 13                            25         2014               529
#> 14                            26         2014               529
#> 15                            27         2014               529
#> 16                            28         2014               529
#> 17                            29         2014               529
#> 18                            31         2014               529
#> 19                            32         2014               529
#> 20                            33         2014               529
#> 21                            35         2014               529
#> 22                            41         2014               529
#> 23                            42         2014               529
#> 24                            43         2014               529
#> 25                            50         2014               529
#> 26                            51         2014               529
#> 27                            52         2014               529


  1. Finally, if you want to put the parameters of the API directly, just execute:
get_sidra(api = "/t/5938/n3/all/v/37/p/last%201/d/v37%200")
#> All others arguments are desconsidered when 'api' is informed
#>    Nível Territorial (Código)    Nível Territorial Unidade de Medida (Código)
#> 2                           3 Unidade da Federação                         40
#> 3                           3 Unidade da Federação                         40
#> 4                           3 Unidade da Federação                         40
#> 5                           3 Unidade da Federação                         40
#> 6                           3 Unidade da Federação                         40
#> 7                           3 Unidade da Federação                         40
#> 8                           3 Unidade da Federação                         40
#> 9                           3 Unidade da Federação                         40
#> 10                          3 Unidade da Federação                         40
#> 11                          3 Unidade da Federação                         40
#> 12                          3 Unidade da Federação                         40
#> 13                          3 Unidade da Federação                         40
#> 14                          3 Unidade da Federação                         40
#> 15                          3 Unidade da Federação                         40
#> 16                          3 Unidade da Federação                         40
#> 17                          3 Unidade da Federação                         40
#> 18                          3 Unidade da Federação                         40
#> 19                          3 Unidade da Federação                         40
#> 20                          3 Unidade da Federação                         40
#> 21                          3 Unidade da Federação                         40
#> 22                          3 Unidade da Federação                         40
#> 23                          3 Unidade da Federação                         40
#> 24                          3 Unidade da Federação                         40
#> 25                          3 Unidade da Federação                         40
#> 26                          3 Unidade da Federação                         40
#> 27                          3 Unidade da Federação                         40
#> 28                          3 Unidade da Federação                         40
#>    Unidade de Medida      Valor Unidade da Federação (Código)
#> 2          Mil Reais   44913978                            11
#> 3          Mil Reais   15331123                            12
#> 4          Mil Reais  100109235                            13
#> 5          Mil Reais   13369988                            14
#> 6          Mil Reais  161349602                            15
#> 7          Mil Reais   16795207                            16
#> 8          Mil Reais   35666183                            17
#> 9          Mil Reais   98179496                            21
#> 10         Mil Reais   50378418                            22
#> 11         Mil Reais  155903825                            23
#> 12         Mil Reais   66969562                            24
#> 13         Mil Reais   64373595                            25
#> 14         Mil Reais  186351975                            26
#> 15         Mil Reais   54413047                            27
#> 16         Mil Reais   42017981                            28
#> 17         Mil Reais  286239541                            29
#> 18         Mil Reais  614875820                            31
#> 19         Mil Reais  137020055                            32
#> 20         Mil Reais  758859047                            33
#> 21         Mil Reais 2210561949                            35
#> 22         Mil Reais  440029403                            41
#> 23         Mil Reais  298227090                            42
#> 24         Mil Reais  457293958                            43
#> 25         Mil Reais  106969142                            50
#> 26         Mil Reais  137442853                            51
#> 27         Mil Reais  195681724                            52
#> 28         Mil Reais  254817205                            53
#>    Unidade da Federação Variável (Código)
#> 2              Rondônia                37
#> 3                  Acre                37
#> 4              Amazonas                37
#> 5               Roraima                37
#> 6                  Pará                37
#> 7                 Amapá                37
#> 8             Tocantins                37
#> 9              Maranhão                37
#> 10                Piauí                37
#> 11                Ceará                37
#> 12  Rio Grande do Norte                37
#> 13              Paraíba                37
#> 14           Pernambuco                37
#> 15              Alagoas                37
#> 16              Sergipe                37
#> 17                Bahia                37
#> 18         Minas Gerais                37
#> 19       Espírito Santo                37
#> 20       Rio de Janeiro                37
#> 21            São Paulo                37
#> 22               Paraná                37
#> 23       Santa Catarina                37
#> 24    Rio Grande do Sul                37
#> 25   Mato Grosso do Sul                37
#> 26          Mato Grosso                37
#> 27                Goiás                37
#> 28     Distrito Federal                37
#>                                    Variável Ano (Código)  Ano
#> 2  Produto Interno Bruto a preços correntes         2018 2018
#> 3  Produto Interno Bruto a preços correntes         2018 2018
#> 4  Produto Interno Bruto a preços correntes         2018 2018
#> 5  Produto Interno Bruto a preços correntes         2018 2018
#> 6  Produto Interno Bruto a preços correntes         2018 2018
#> 7  Produto Interno Bruto a preços correntes         2018 2018
#> 8  Produto Interno Bruto a preços correntes         2018 2018
#> 9  Produto Interno Bruto a preços correntes         2018 2018
#> 10 Produto Interno Bruto a preços correntes         2018 2018
#> 11 Produto Interno Bruto a preços correntes         2018 2018
#> 12 Produto Interno Bruto a preços correntes         2018 2018
#> 13 Produto Interno Bruto a preços correntes         2018 2018
#> 14 Produto Interno Bruto a preços correntes         2018 2018
#> 15 Produto Interno Bruto a preços correntes         2018 2018
#> 16 Produto Interno Bruto a preços correntes         2018 2018
#> 17 Produto Interno Bruto a preços correntes         2018 2018
#> 18 Produto Interno Bruto a preços correntes         2018 2018
#> 19 Produto Interno Bruto a preços correntes         2018 2018
#> 20 Produto Interno Bruto a preços correntes         2018 2018
#> 21 Produto Interno Bruto a preços correntes         2018 2018
#> 22 Produto Interno Bruto a preços correntes         2018 2018
#> 23 Produto Interno Bruto a preços correntes         2018 2018
#> 24 Produto Interno Bruto a preços correntes         2018 2018
#> 25 Produto Interno Bruto a preços correntes         2018 2018
#> 26 Produto Interno Bruto a preços correntes         2018 2018
#> 27 Produto Interno Bruto a preços correntes         2018 2018
#> 28 Produto Interno Bruto a preços correntes         2018 2018


For most users the data request is done via the online portal (https://sidra.ibge.gov.br). In this case, if you want to save the parameters of the table selected in the portal to a posterior request of the same table via sidrar, you should copy the path in the red rectangle and pass to the api argument in get_sidra:



info_sidra

In the previous examples we know how to recover data from tables according to the parameters reported. However, if I do not know what the parameters are, how should I proceed? To verify the parameters (variables, classifications, periods, etc.) of a given table, simply use the function “info_sidra”, informing the code of the table. The function returns a list with the possible parameters in the console. However, if wb = TRUE, the user can allow the result to be displayed in an web browser.

#> $table
#> [1] "Tabela 5939: Índice de Gini do produto interno bruto a preços correntes e do valor adicionado bruto a preços correntes por atividade econômica - Referência 2010"
#> 
#> $period
#> [1] "2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018"
#> 
#> $variable
#>    cod
#> 1  529
#> 2  531
#> 3  532
#> 4 6568
#> 5  534
#>                                                                                                                                                                                desc
#> 1                                                                                               Índice de Gini da distribuição do produto interno bruto a preços correntes (Índice)
#> 2                                                                              Índice de Gini da distribuição do valor adicionado bruto a preços correntes da agropecuária (Índice)
#> 3                                                                                 Índice de Gini da distribuição do valor adicionado bruto a preços correntes da indústria (Índice)
#> 4 Índice de Gini da distribuição do valor adicionado bruto a preços correntes dos serviços, exclusive administração, defesa, educação e saúde públicas e seguridade social (Índice)
#> 5                      Índice de Gini da distribuição do valor adicionado bruto a preços correntes da administração, defesa, educação e saúde públicas e seguridade social (Índice)
#> 
#> $classific_category
#> NULL
#> 
#> $geo
#>      cod                      desc
#> 1 Brazil                Brasil (1)
#> 2 Region         Grande Região (5)
#> 3  State Unidade da Federação (26)

if wb = TRUE:

info_sidra(5939, wb = TRUE)
#> Can the web browser be open? (y/n):

By placing y, we have in this example:


search_sidra

If the user wants to know if there is a table that contains a certain term / word, simply use the function ** search_sidra ** informing the words of interest. The function returns the tables containing these terms in their headings.

search_sidra(c("gini"))
#>  [1] "Tabela 155 - Índice de Gini da renda das pessoas responsáveis pelos domicílios"                                                                                                                                                                                         
#>  [2] "Tabela 299 - Índice de Gini da distribuição do rendimento mensal das pessoas de 10 anos ou mais de idade com rendimento, por sexo"                                                                                                                                      
#>  [3] "Tabela 379 - Índice de Gini - recebimento médio mensal das famílias"                                                                                                                                                                                                    
#>  [4] "Tabela 403 - Índice de Gini da distribuição do rendimento mensal dos domicílios particulares permanentes, com rendimento"                                                                                                                                               
#>  [5] "Tabela 411 - Índice de Gini da distribuição do rendimento mensal de todos os trabalhos das pessoas de 10 anos ou mais de idade, ocupadas na semana de referência, com rendimento de trabalho, por sexo"                                                                 
#>  [6] "Tabela 567 - Índice de Gini da distribuição do rendimento mensal das pessoas de 10 anos ou mais de idade com rendimento, por sexo (exceto a área rural da Região Norte - exclusive a de Tocantins)"                                                                     
#>  [7] "Tabela 570 - Índice de Gini da distribuição do rendimento mensal de todos os trabalhos das pessoas de 10 anos ou mais de idade, ocupadas na semana de referência, com rendimento de trabalho, por sexo (exceto a área rural da Região Norte - exclusive a de Tocantins)"
#>  [8] "Tabela 573 - Índice de Gini da distribuição do rendimento mensal dos domicílios particulares permanentes, com rendimento (exceto a área rural de Rondônia, Acre, Amazonas, Roraima, Pará e Amapá)"                                                                      
#>  [9] "Tabela 599 - Índice de Gini do produto interno bruto a preços correntes e do valor adicionado bruto a preços correntes por atividade econômica - Referência 2002 (Série encerrada)"                                                                                     
#> [10] "Tabela 1167 - Índice de Gini da distribuição do rendimento mensal das pessoas de 10 anos ou mais de idade, com rendimento"                                                                                                                                              
#> [11] "Tabela 1722 - Índice de Gini da distribuição do rendimento nominal mensal das pessoas de 10 anos ou mais de idade, com rendimento, por situação do domicílio e sexo"                                                                                                    
#> [12] "Tabela 2036 - Índice de Gini da distribuição do rendimento nominal mensal das pessoas de 10 anos ou mais de idade, com rendimento, por situação do domicílio"                                                                                                           
#> [13] "Tabela 2037 - Índice de Gini da distribuição do rendimento nominal mensal dos domicílios particulares permanentes, com rendimento domiciliar, por situação do domicílio"                                                                                                
#> [14] "Tabela 2906 - Índice de Gini da distribuição do rendimento nominal mensal das pessoas de 10 anos ou mais de idade, com rendimento, por condição de ativiidade na semana de referência, sexo e situação do domicílio"                                                    
#> [15] "Tabela 2907 - Índice de Gini da distribuição do rendimento nominal mensal de todos os trabalhos das pessoas de 10 anos ou mais de idade, ocupadas na semana de referêrncia,com rendimento de trabalho, por sexo e situação do domicílio"                                
#> [16] "Tabela 2932 - Índice de Gini da distribuição do rendimento nominal mensal das famílias residentes em domicílios particulares, com rendimento familiar, por situação do domicílio"                                                                                       
#> [17] "Tabela 3568 - Índice de Gini da distribuição do rendimento nominal mensal dos domicílios particulares permanentes, com rendimento domiciliar, por situação do domicílio - Amostra Rendimento"                                                                           
#> [18] "Tabela 5642 - Índice de Gini da distribuição do rendimento mensal das pessoas de 15 anos ou mais de idade, com rendimento"                                                                                                                                              
#> [19] "Tabela 5801 - Índice de Gini da distribuição do rendimento mensal das pessoas de 15 anos ou mais de idade, com rendimento - Série Histórica"                                                                                                                            
#> [20] "Tabela 5939 - Índice de Gini do produto interno bruto a preços correntes e do valor adicionado bruto a preços correntes por atividade econômica - Referência 2010"