Type: Package
Title: Download Official Data on Brazil's Federal Budget
Version: 1.0.4
Description: Allows users to download and analyze official data on Brazil's federal budget through the 'SPARQL' endpoint provided by the Integrated Budget and Planning System ('SIOP'). This package enables access to detailed information on budget allocations and expenditures of the federal government, making it easier to analyze and visualize these data. Technical information on the Brazilian federal budget is available (Portuguese only) at https://www1.siop.planejamento.gov.br/mto/. The 'SIOP' endpoint is available at https://www1.siop.planejamento.gov.br/sparql/.
License: GPL (≥ 3)
Encoding: UTF-8
Imports: httr, jsonlite
RoxygenNote: 7.3.2
NeedsCompilation: no
Packaged: 2025-04-04 14:25:44 UTC; daniel.reiss
Author: Daniel Gersten Reiss ORCID iD [aut, cre], Bernardo Borba de Andrade ORCID iD [ctb], Gustavo José de Guimarães e Souza ORCID iD [ctb], Ministério do Planejamento e Orçamento [cph, fnd]
Maintainer: Daniel Gersten Reiss <daniel.reiss@planejamento.gov.br>
Repository: CRAN
Date/Publication: 2025-04-05 11:20:10 UTC

Download expenditure data from the Brazilian federal budget.

Description

This function downloads expenditure data from the Brazilian federal budget. It resorts on the SIOP API. For more information on the Brazilian Budget, please refer to the Budget Technical Manual, available in Portuguese at Manual Técnico do Orçamento.

PT-BR: Essa função faz o download dos dados da despesa do orçamento da União do Brasil. Os dados são baixados por meio da API do SIOP. Para mais informação sobre o orçamento brasileiro, não deixe de consultar o Manual Técnico do Orçamento.

Usage

despesaDetalhada(
  exercicio = .last_year(),
  Esfera = FALSE,
  Orgao = FALSE,
  UO = FALSE,
  Funcao = FALSE,
  Subfuncao = FALSE,
  Programa = FALSE,
  Acao = FALSE,
  PlanoOrcamentario = FALSE,
  Subtitulo = FALSE,
  CategoriaEconomica = FALSE,
  GND = FALSE,
  ModalidadeAplicacao = FALSE,
  ElementoDespesa = FALSE,
  Fonte = FALSE,
  IdUso = FALSE,
  ResultadoPrimario = FALSE,
  valorPLOA = TRUE,
  valorLOA = TRUE,
  valorLOAmaisCredito = TRUE,
  valorEmpenhado = TRUE,
  valorLiquidado = TRUE,
  valorPago = TRUE,
  incluiDescricoes = TRUE,
  detalheMaximo = FALSE,
  ignoreSecureCertificate = FALSE,
  timeout = 0,
  print_url = FALSE
)

Arguments

exercicio

A number. Indicates the year to which the extracted data refers. (Indica o ano a que se refere a extração)

The following parameters are Boolean values. If a parameter is set to TRUE, the returned dataframe will be detailed according to the respective dimension. If a parameter is set to FALSE, the figures will be aggregated.

(Os parâmetros que seguem são valores booleanos. Se um parâmetro estiver definido como TRUE, o dataframe retornado será detalhado de acordo com a respectiva dimensão. Se um parâmetro estiver definido como FALSE, os valores serão agregados.)

* Dimensions (Nível de detalhamento)

QUALITATIVE CLASSIFICATION (CLASSIFICAÇÃO QUALITATIVA)

Classification by Budget segment (Classificação por Esfera)

Esfera

Budget segment (Esfera Orçamentária)

Institutional Classification (Classificação Institucional)

Orgao

Agency (Órgão)

UO

Budgetary Unit (Unidade Orçamentária)

Functional Classification (Classificação Funcional)

Funcao

Function (Função)

Subfuncao

Subfunction (Subfunção)

Programmatic Structure (Classificação Programática)

Programa

Program (Programa)

Acao

Activity (Ação)

PlanoOrcamentario

Budget Plan (Plano orçamentárip)

Subtitulo

Subtitle (Subtítulo)

QUANTITATIVE CLASSIFICATION (CLASSIFICAÇÃO QUANTITATIVA)

Detailed Financial Programming (Componentes da programação financeira)

CategoriaEconomica

Economic Category (categoria Econômica)

GND

Nature of Expenditure (Grupo Natureza da Despesa)

ModalidadeAplicacao

Application Mode (Modalidade de Aplicação)

ElementoDespesa

Expenditure Element (Elemento da Despesa)

Fonte

Fonte de Recursos (Source of Funds)

IdUso

Resources used as a counterpart Identifier (Identificador de recursos utilizado como contrapartida)

ResultadoPrimario

Primary Result Identifier (Idenfificador de efeito sobre o resultado primário da União)

The following parameters are Boolean values. If a parameter is set to TRUE, the returned dataframe will include the respective figure. By default, all metrics are set to TRUE.

(Os seguintes parâmetros são valores booleanos. Se um parâmetro estiver definido como TRUE, o dataframe retornado incluirá a respectiva métrica. Todas as métricas são definidas como TRUE por padrão.)

valorPLOA

Annual Budget Bill value (Valor do PLOA)

valorLOA

Annual Budget Law value - LOA (Valor da LOA)

valorLOAmaisCredito

LOA value plus additional credits - Total authorized value (Valor da LOA adicionado de créditos adicionais)

valorEmpenhado

Committed value (Valor empenhado)

valorLiquidado

Verified value (Valor liquidado)

valorPago

Paid value (Valor pago)

incluiDescricoes

A Boolean. If the parameter is set to TRUE, the returned dataframe will include a column describing each selected dimension. If the parameter is set to FALSE, only the dimension codes will be returned. The default value is TRUE. (Se o parâmetro estiver definido como TRUE, o dataframe retornado incluirá uma coluna descrevendo cada dimensão selecionada. Se o parâmetro estiver definido como FALSE, apenas os códigos das dimensões serão retornados. O valor padrão é TRUE.)

detalheMaximo

A Boolean. If the parameter is set to TRUE, the returned dataframe will be disaggregated across all available dimensions, overriding any dimension choices made by other parameters. If the parameter is set to FALSE, only the selected dimensions will be returned. The default value is FALSE. (Se o parâmetro estiver definido como TRUE, o dataframe retornado será desagregado em todas as dimensões disponíveis, substituindo qualquer escolha de dimensão feita por outros parâmetros. Se o parâmetro estiver definido como FALSE, apenas as dimensões selecionadas serão retornadas. O valor padrão é FALSE.)

ignoreSecureCertificate

A Boolean. If the parameter is set to TRUE, the download of SIOP data will proceed while ignoring the secure certificate. (Se o parâmetro estiver definido como TRUE, o download dos dados do SIOP será realizado ignorando o certificado seguro.)

timeout

An Integer. Milliseconds to server timeout. Values less than 1000 are ignored by SIOP server. (Milisegundos até o timeout do servidor. Valores menores que 1000 são ignorados pelo servidor.)

print_url

A Boolean. If the parameter is set to TRUE, the function prints the constructed url before reaching the SIOP endpooint. (Se o parâmetro estiver definido como TRUE, a função exibe a url utilizanda antes de acessar o endpoint.)

Value

The dataframe contains the expenditure figures. The columns are based on the choices made in the parameters.

PT-BR: O dataframe contém os valores de despesa. As colunas são baseadas nas escolhas feitas nos parâmetros.

Examples

## Not run: despesaDetalhada(2020, UO = "73901", valorPLOA = FALSE, detalheMaximo = TRUE)

## Not run: despesaDetalhada(exercicio = 2023, ResultadoPrimario = "6")

Download expenditure data from the Brazilian federal budget.

Description

This function calls despesaDetalhada().

Usage

detailedExpenditure(
  exercicio,
  Esfera,
  Orgao,
  UO,
  Funcao,
  Subfuncao,
  Programa,
  Acao,
  PlanoOrcamentario,
  Subtitulo,
  CategoriaEconomica,
  GND,
  ModalidadeAplicacao,
  ElementoDespesa,
  Fonte,
  IdUso,
  ResultadoPrimario,
  valorPLOA,
  valorLOA,
  valorLOAmaisCredito,
  valorEmpenhado,
  valorLiquidado,
  valorPago,
  incluiDescricoes,
  detalheMaximo,
  ignoreSecureCertificate,
  timeout,
  print_url
)

Arguments

exercicio

A number. Indicates the year to which the extracted data refers. (Indica o ano a que se refere a extração)

The following parameters are Boolean values. If a parameter is set to TRUE, the returned dataframe will be detailed according to the respective dimension. If a parameter is set to FALSE, the figures will be aggregated.

(Os parâmetros que seguem são valores booleanos. Se um parâmetro estiver definido como TRUE, o dataframe retornado será detalhado de acordo com a respectiva dimensão. Se um parâmetro estiver definido como FALSE, os valores serão agregados.)

* Dimensions (Nível de detalhamento)

QUALITATIVE CLASSIFICATION (CLASSIFICAÇÃO QUALITATIVA)

Classification by Budget segment (Classificação por Esfera)

Esfera

Budget segment (Esfera Orçamentária)

Institutional Classification (Classificação Institucional)

Orgao

Agency (Órgão)

UO

Budgetary Unit (Unidade Orçamentária)

Functional Classification (Classificação Funcional)

Funcao

Function (Função)

Subfuncao

Subfunction (Subfunção)

Programmatic Structure (Classificação Programática)

Programa

Program (Programa)

Acao

Activity (Ação)

PlanoOrcamentario

Budget Plan (Plano orçamentárip)

Subtitulo

Subtitle (Subtítulo)

QUANTITATIVE CLASSIFICATION (CLASSIFICAÇÃO QUANTITATIVA)

Detailed Financial Programming (Componentes da programação financeira)

CategoriaEconomica

Economic Category (categoria Econômica)

GND

Nature of Expenditure (Grupo Natureza da Despesa)

ModalidadeAplicacao

Application Mode (Modalidade de Aplicação)

ElementoDespesa

Expenditure Element (Elemento da Despesa)

Fonte

Fonte de Recursos (Source of Funds)

IdUso

Resources used as a counterpart Identifier (Identificador de recursos utilizado como contrapartida)

ResultadoPrimario

Primary Result Identifier (Idenfificador de efeito sobre o resultado primário da União)

The following parameters are Boolean values. If a parameter is set to TRUE, the returned dataframe will include the respective figure. By default, all metrics are set to TRUE.

(Os seguintes parâmetros são valores booleanos. Se um parâmetro estiver definido como TRUE, o dataframe retornado incluirá a respectiva métrica. Todas as métricas são definidas como TRUE por padrão.)

valorPLOA

Annual Budget Bill value (Valor do PLOA)

valorLOA

Annual Budget Law value - LOA (Valor da LOA)

valorLOAmaisCredito

LOA value plus additional credits - Total authorized value (Valor da LOA adicionado de créditos adicionais)

valorEmpenhado

Committed value (Valor empenhado)

valorLiquidado

Verified value (Valor liquidado)

valorPago

Paid value (Valor pago)

incluiDescricoes

A Boolean. If the parameter is set to TRUE, the returned dataframe will include a column describing each selected dimension. If the parameter is set to FALSE, only the dimension codes will be returned. The default value is TRUE. (Se o parâmetro estiver definido como TRUE, o dataframe retornado incluirá uma coluna descrevendo cada dimensão selecionada. Se o parâmetro estiver definido como FALSE, apenas os códigos das dimensões serão retornados. O valor padrão é TRUE.)

detalheMaximo

A Boolean. If the parameter is set to TRUE, the returned dataframe will be disaggregated across all available dimensions, overriding any dimension choices made by other parameters. If the parameter is set to FALSE, only the selected dimensions will be returned. The default value is FALSE. (Se o parâmetro estiver definido como TRUE, o dataframe retornado será desagregado em todas as dimensões disponíveis, substituindo qualquer escolha de dimensão feita por outros parâmetros. Se o parâmetro estiver definido como FALSE, apenas as dimensões selecionadas serão retornadas. O valor padrão é FALSE.)

ignoreSecureCertificate

A Boolean. If the parameter is set to TRUE, the download of SIOP data will proceed while ignoring the secure certificate. (Se o parâmetro estiver definido como TRUE, o download dos dados do SIOP será realizado ignorando o certificado seguro.)

timeout

An Integer. Milliseconds to server timeout. Values less than 1000 are ignored by SIOP server. (Milisegundos até o timeout do servidor. Valores menores que 1000 são ignorados pelo servidor.)

print_url

A Boolean. If the parameter is set to TRUE, the function prints the constructed url before reaching the SIOP endpooint. (Se o parâmetro estiver definido como TRUE, a função exibe a url utilizanda antes de acessar o endpoint.)

Value

The dataframe contains the expenditure figures. The columns are based on the choices made in the parameters.

Federal Budget Dimensions

Description

Here, we list the dimensions concerning Federal Budget expenditure. For additional information, please refer to the 'Manual Técnico do Orçamento'.

PT-BR: Aqui, listamos as dimensões relativas aos gastos do Orçamento Federal. Para informações adicionais, consulte o 'Manual Técnico do Orçamento'.

Classificação do Orçamento Federal - dimensões

Parameter Classification by Budget segment Classificação por Esfera
Esfera Budget segment Esfera Orçamentária
.
Institutional Classification Classificação Institucional
Orgao Agency Órgão
UO Budgetary Unit Unidade Orçamentária
.
Functional Classification Classificação Funcional
Funcao Function Função
Subfuncao Subfunction Subfunção
.
Programmatic Structure Classificação Programática
Programa Program Programa
Acao Activity Ação
PlanoOrcamentario Budget Plan Plano orçamentário
Subtitulo Subtitle Subtítulo
.
Detailed Financial Programming Componentes da programação financeira
CategoriaEconomica Economic Category Categoria Econômica
GND Nature of Expenditure Grupo Natureza da Despesa
ModalidadeAplicacao Application Mode Modalidade de Aplicação
ElementoDespesa Expenditure Element Elemento da Despesa
.
Fonte Source of Funds Fonte de Recursos
IdUso Resources used as a counterpart Identifier Identificador de recursos utilizado como contrapartida
ResultadoPrimario Primary Result Identifier Identificador de efeito sobre o resultado primário da União

List of Members in a Brazilian Federal Budget Dimension.

Description

This function lists all members in a Brazilian Federal Budget dimension for a given year.

Usage

quaisMembros(
  exercicio = .last_year(),
  dimensao,
  ignoreSecureCertificate = FALSE
)

Arguments

exercicio

A number. Indicates the year to which the extracted data refers. (Indica o ano a que se refere a extração)

dimensao

A string. The dimension to be listed. (A dimensão a ser relacionada) Valid values (Valores válidos): dimensoes

ignoreSecureCertificate

A Boolean. If the parameter is set to TRUE, the download of SIOP data will proceed while ignoring the secure certificate. (Se o parâmetro estiver definido como TRUE, o download dos dados do SIOP será realizado ignorando o certificado seguro.)

Value

The dataframe contains the members in a dimension. Both code and description are provided.

Examples

## Not run: quaisMembros(2023, dimensao = "Funcao")

List of Members in a Brazilian Federal Budget Dimension.

Description

This function calls [quaisMembros].

Usage

whichMembers(
  exercicio = .last_year(),
  dimensao,
  ignoreSecureCertificate = FALSE
)

Arguments

exercicio

A number. Indicates the year to which the extracted data refers.

dimensao

A string. The dimension to be listed. Valid values: [dimensoes]

ignoreSecureCertificate

A Boolean. If the parameter is set to TRUE, the download of SIOP data will proceed while ignoring the secure certificate. (Se o parâmetro estiver definido como TRUE, o download dos dados do SIOP será realizado ignorando o certificado seguro.)

Value

The dataframe contains the members in a dimension. Both code and description are provided.

Examples

## Not run: whichMembers(2023, dimensao = "Funcao")