detailedExpenditure: 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
)

Value

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

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