Package 'siconvr'

Title: Fetch Data from Plataforma +Brasil (SICONV)
Description: Fetch data on targeted public investments from Plataforma +Brasil (SICONV) <http://plataformamaisbrasil.gov.br/>, the responsible system for requests, execution, and monitoring of federal discretionary transfers in Brazil.
Authors: Fernando Meireles [aut, cre] , Marcus Vinícius de Sá Torres [aut]
Maintainer: Fernando Meireles <[email protected]>
License: GPL (>= 3)
Version: 0.0.2.900
Built: 2025-02-09 05:30:35 UTC
Source: https://github.com/meirelesff/siconvr

Help Index

Fetch cleaned data from Plataforma +Brasil

Description

get_siconv() is the package's workhorse. It downloads, cleans, and returns one of the several datasets maintained by Plataforma +Brasil on federal targeted transfers in Brazil. Under the hoods, the function handles GET requests, downloads and stores intermediary files, and reads as fast as possible the data to a tibble format convenient for use in analysis.

Usage

get_siconv(dataset = NULL, encoding = "UTF-8", cache = TRUE, verbose = TRUE)

Arguments

dataset

A string indicating the dataset to retrieve. Valid options:

  • "programas" – data on available programs maintained by the Federal Government;

  • "programas_propostas" – keys to match programs and proposals submitted to the Federal Government;

  • "propostas" – data on proposals submitted to the Federal Government;

  • "convenios" – data on proposals effectively accepted situation and amount transferred by the Federal Government;

  • "pagamento" – data on payments to local providers;

  • "emendas" – data on federal budget amendments made by Brazilian Federal Deputies and Senators, amount transferred and the transference recipient;

  • "planos" – data on application plans submitted to the Federal Government. This document includes all goods, services and works required by the covenant to accomplish the project;

  • "empenhos" – data on transfers which the Federal Government has reserved its budget to pay the covenant when the project ends;

  • "desembolsos" – data on transfers disbursements by the Federal Government;

  • "obtv" – data on payments made to local suppliers and contractors hired to execute funded projects;

  • "historico" – proposals' track record;

  • "ingresso_contrapartida" – record of counterpart payments;

  • "aditivos" – data on contracts' budget addendum;

  • "crono_metas" – project's goals timeline;

  • "cronogramas" – project's execution timeline;

  • "consorcios" – data on proposals where multiple local governments or private entities cooperate to request federal resources;

  • "empenhos_desembolsos" – keys to match appropriations and disbursements by Federal Government;

  • "proponentes" – data on proposals' proponents;

  • "cronograma_desembolsos" – project's transfers disbursements timeline;

  • "justificativas" – proposals' justifications;

When not specified, dataset defaults to "programas".
encoding

Encoding used to read raw files. Defaults to "UTF-8", but users might need to change this option to other valid options (e.g., "latin1") if data are returned with uncommon characters.
cache

Should the function maintain a local copy of the data? To save both time and SICONV's server resources, this defaults to TRUE. Data is stored as a zipfile in the foleer "cache" in the working directory (avoid changing files' names inside this folder).
verbose

Should the function display messages and progress bar? Defaults to TRUE.

Value

A tibble contantaining the requested data as defined in the dataset argument. Use the show_schema function to get detailed information on available variables and information.

Note

get_siconv() needs an internet connection to download data in case it does not found a cache folder with raw data from a previous request. Be aware that instability in the Plataforma +Brasil server might produce error messagens, in which case users should try waiting before rerunning their requests.

Examples

## Not run: df <- get_siconv(dataset = "propostas")

Access Plataforma +Brasil's documentation

Description

show_schema() downloads, unzips, and show in a web browser Plataforma +Brasil's full database documentation, including its schema and other usefull information. Docs are downloaded to a folder in the working directory.

Usage

show_schema(verbose = TRUE, browser = TRUE)

Arguments

verbose

Should the function display messages and progress bar? Defaults to TRUE.
browser

Should the function open a web browser to display the docs? Defaults to TRUE.

Value

show_schema() is most usefull for its side effect of downloading, when needed, and opening Plataforma +Brasil's documentation, but is also silently returns a string containing the path to the docs' index file.

Note

show_schema() needs an internet connection to download data in case it does not found a cache folder with the docs from a previous request. Be aware that instability in the Plataforma +Brasil server might produce error messagens, in which case users should try waiting before rerunning the function.

Examples

## Not run: show_schema()