despesaDetalhada {orcamentoBR} | R Documentation |
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 (Os parâmetros que seguem são valores booleanos. Se um parâmetro estiver
definido como * 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 (Os seguintes parâmetros são valores booleanos. Se um parâmetro estiver
definido como |
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 |
detalheMaximo |
A Boolean. If the parameter is set to |
ignoreSecureCertificate |
A Boolean. If the parameter is set to |
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 |
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")