Package 'transfRgov'

Obter Mapeamento SIAFI-IBGE de Municípios

Description

Baixa a tabela de mapeamento entre códigos SIAFI e IBGE de municípios do Tesouro Transparente.

Usage

baixa_municipio_siafibge()

Details

Esta função baixa o arquivo tabmun.csv, que contém o mapeamento entre códigos SIAFI e IBGE de municípios brasileiros, do portal Tesouro Transparente CKAN. Os dados são comumente separados por vírgulas e podem estar em codificação UTF-8 ou Latin1. É crucial que as colunas de código sejam lidas como texto para preservar zeros à esquerda antes de realizar joins. Requer o pacote 'readr' e 'utils'.

Value

Um data frame contendo o mapeamento de municípios. Retorna NULL (invisível) se ocorrer um erro.

---

Listar os campos aceitos por cada endpoint da API Fundo a Fundo

Description

Acessor do conjunto de dados metafaftab. Transforma a lista crua de caminhos e vetores em uma tabela de três colunas (endpoint, campo e controle) ou devolve apenas o vetor de campos de um endpoint escolhido.

Usage

campos_metafaftab(endpoint = NULL, incluir_controle = FALSE)

Arguments

endpoint	Caminho de um endpoint, em texto. Pode ser informado com ou sem a barra inicial ("/programa" ou "programa"). Quando NULL (o padrão), a função descreve todos os endpoints.
incluir_controle	Lógico. Cada endpoint aceita os parâmetros de controle do PostgREST (order, range, rangeUnit, offset, limit, preferCount e select), que não são colunas da resposta e por isso ficam fora do resultado por padrão (FALSE). Com TRUE eles são incluídos e sinalizados pela coluna controle.

Details

A função é útil para descobrir os nomes válidos dos argumentos das funções ler_*/get_* do pacote, que refletem os campos da API. Por exemplo, campos_metafaftab("empenho") lista os filtros aceitos por ler_empenho.

Dos 21 endpoints, 19 expõem um select comum; /plano_acao expõe select_plano_acao e /relatorio_gestao_analise expõe select_relatorio_gestao_analise. Os demais seis controles aparecem nos 21 endpoints, o que dá sete parâmetros de controle por endpoint.

Value

Com endpoint = NULL, um data.frame com as colunas endpoint (caminho do endpoint), campo (nome do parâmetro) e controle (lógico, indica se o campo é um parâmetro de controle do PostgREST e não uma coluna). Com um endpoint informado, um vetor de caracteres com os campos daquele endpoint, na ordem em que aparecem no metafaftab.

See Also

metafaftab

Examples

head(campos_metafaftab())
campos_metafaftab("/programa")

---

Consultar Valores de Renúncia Fiscal

Description

Esta função busca os dados de renúncias fiscais da API do Portal da Transparência do Governo Federal.

Usage

consultar_renuncias_fiscais(
  pagina = 1,
  uf = NULL,
  codigo_ibge = NULL,
  cnpj = NULL,
  chave_api = Sys.getenv("PORTAL_TRANSPARENCIA_API_KEY")
)

Arguments

pagina	O número da página a ser retornada. O padrão é 1.
uf	String com o nome ou a sigla da Unidade Federativa a ser consultada. Ex: "São Paulo" ou "SP".
codigo_ibge	String com o código IBGE do município a ser consultado.
cnpj	String com o CNPJ do beneficiário a ser consultado (apenas números).
chave_api	A sua chave da API. Por padrão, a função buscará a variável de ambiente 'PORTAL_TRANSPARENCIA_API_KEY'.

Value

Um data.frame com os dados das renúncias fiscais.

Examples

## Not run: 
  # Para usar esta função, você precisa de uma chave de API válida,
  # configurada na variável de ambiente 'PORTAL_TRANSPARENCIA_API_KEY'.
  dados_renuncia <- consultar_renuncias_fiscais(pagina = 1, uf = "SP")
  print(dados_renuncia)

## End(Not run)

---

Baixar Dados de Despesas do Portal da Transparência

Description

Baixa os dados diários de despesas da União publicados pelo Portal da Transparência (CGU) para uma data específica.

Usage

download_despesas_ptransp(
  data,
  tipo = c("empenho", "item_empenho", "item_empenho_historico", "liquidacao",
    "liquidacao_empenhos_impactados", "pagamento", "pagamento_empenhos_impactados",
    "pagamento_favorecidos_finais", "pagamento_lista_bancos", "pagamento_lista_faturas",
    "pagamento_lista_precatorios")
)

Arguments

data	Um objeto Date (ou valor conversível a Date, como a string "2024-01-15") com a data desejada. Uma única data por chamada.
tipo	Qual dos arquivos contidos no ZIP diário deve ser lido. O padrão é "empenho"; use tipo para escolher outro arquivo. Ver Detalhes para a lista completa e para o encadeamento entre arquivos.

Details

A função monta a URL do arquivo {AAAAMMDD}_Despesas.zip, baixa o arquivo, descompacta e lê o CSV correspondente ao tipo informado. O ZIP diário reúne onze arquivos, um por tipo de registro: empenho, item_empenho, item_empenho_historico, liquidacao, liquidacao_empenhos_impactados, pagamento, pagamento_empenhos_impactados, pagamento_favorecidos_finais, pagamento_lista_bancos, pagamento_lista_faturas e pagamento_lista_precatorios. O dicionário de dados e os arquivos podem ser consultados em https://dadosabertos-download.cgu.gov.br/PortalDaTransparencia/saida/despesas/.

Chegar ao beneficiário final de um pagamento exige encadear dois arquivos: pagamento traz o total por ordem bancária (colunas codigo_pagamento e valor_do_pagamento_convertido_pra_r) e pagamento_favorecidos_finais traz os beneficiários daquela ordem (colunas codigo_pagamento, codigo_favorecido e valor_do_pagamento_em_r). A junção é 1:N por codigo_pagamento e cobre apenas as ordens detalhadas. O mesmo encadeamento vale para liquidacao com liquidacao_empenhos_impactados, pagamento com pagamento_empenhos_impactados e empenho com item_empenho (por id_empenho).

A função lida com arquivos temporários e tenta ler o CSV considerando a codificação e os separadores comuns no Portal. Requer os pacotes 'readr', 'janitor' e 'utils'.

Value

Um data frame com o conteúdo do arquivo escolhido e nomes de coluna normalizados por janitor::clean_names(). Dias sem movimento não são erro: o data frame volta com zero linhas. Retorna NULL (invisível) e emite warning() se o download, a descompactação ou a leitura falhar.

---

Baixar Dados de Transferências da União

Description

Baixa dados de transferências de recursos da União do Portal da Transparência para um ano e mês específicos.

Usage

download_transferencias_uniao(
  ano,
  mes,
  codigo_ibge = TRUE,
  municipios_mapping = NULL
)

Arguments

ano	O ano dos dados (inteiro, e.g., 2023).
mes	O mês dos dados (inteiro, 1-12).
codigo_ibge	Lógico. Se TRUE (o padrão), acrescenta a coluna codigo_ibge aos dados, por meio do mapeamento SIAFI-IBGE.
municipios_mapping	possibilidade de passar mapeamento distinto do padrão incluído no pacote

Details

Esta função monta a URL do arquivo ZIP de "Recursos transferidos" do Portal da Transparência referente ao ano e mês informados, baixa o arquivo, descompacta e lê o CSV resultante. O dicionário de dados pode ser consultado em https://portaldatransparencia.gov.br/pagina-interna/603420-dicionario-de-dados-recursos-transferidos. A função lida com arquivos temporários e tenta ler o CSV considerando a codificação e os separadores comuns no Portal. Requer os pacotes 'readr', 'janitor' e 'utils'.

Value

Um data frame contendo os dados de transferências. Retorna NULL (invisível) se ocorrer um erro.

---

Encadear dois arquivos de despesas do Portal da Transparência

Description

Junta um arquivo de despesas que traz o total por registro com o arquivo que traz o detalhamento desse mesmo registro. No caso mais usado, o total por ordem bancária (pagamento) e os beneficiários daquela ordem (pagamento_favorecidos_finais).

Usage

encadeia_despesas_ptransp(
  total,
  detalhe,
  chave = "codigo_pagamento",
  somente_detalhados = FALSE
)

Arguments

total	Um data.frame com uma linha de total por registro. É o resultado de download_despesas_ptransp() para o tipo agregador (por exemplo "pagamento").
detalhe	Um data.frame com zero ou mais linhas de detalhe por registro. É o resultado de download_despesas_ptransp() para o tipo detalhado (por exemplo "pagamento_favorecidos_finais").
chave	Texto com o nome da coluna que identifica o registro nos dois data frames. O padrão "codigo_pagamento" serve ao par pagamento × pagamento_favorecidos_finais; use "id_empenho" no par empenho × item_empenho.
somente_detalhados	Lógico. Com FALSE (o padrão) toda linha de total aparece no resultado, e as colunas de detalhe ficam NA onde não há detalhamento. Com TRUE, só as linhas de total que têm ao menos uma linha em detalhe são devolvidas.

Details

A junção é 1:N na coluna chave, como em merge(..., all.x = !somente_detalhados, sort = FALSE). Ela foi medida em 2024-01-15: pagamento tinha 14.949 ordens bancárias e pagamento_favorecidos_finais detalhava 162 delas, com 99 dessas 162 trazendo mais de um beneficiário. A soma dos detalhes fecha com valor_do_pagamento_convertido_pra_r (maior diferença encontrada: 3,6e-12, tolerância 0,01).

O detalhamento é parcial: no dia medido, apenas cerca de 1% das ordens bancárias tinham linha correspondente no arquivo de beneficiários. Por isso o padrão é devolver todas as linhas de total, e não tratar um dia sem detalhamento como erro.

Os pares total/detalhe do ZIP diário e as chaves correspondentes são: liquidacao com liquidacao_empenhos_impactados, pagamento com pagamento_empenhos_impactados e pagamento com pagamento_favorecidos_finais (todos por codigo_pagamento ou pela coluna de mesmo nome nos dois lados) e empenho com item_empenho (por id_empenho).

Os nomes das colunas de valor não coincidem entre os lados: o total por ordem bancária usa valor_do_pagamento_convertido_pra_r e o detalhamento usa valor_do_pagamento_em_r. A função não compara valores; ela entrega as duas colunas lado a lado.

Value

Um data.frame com as colunas de total seguidas das colunas exclusivas de detalhe, na ordem em que aparecem nas entradas. A coluna detalhado (lógica), inserida logo depois da coluna chave, indica quais linhas encontraram detalhamento. Colunas homônimas nos dois data frames recebem os sufixos .total e .detalhe. A ordem das linhas de total é preservada, e quando um registro tem mais de um detalhe as linhas ficam adjacentes. Um detalhe com zero linhas não é erro: o resultado sai com as colunas de detalhe em NA e detalhado = FALSE.

See Also

download_despesas_ptransp

Examples

total <- data.frame(
  codigo_pagamento = c("A", "B", "C"),
  valor_do_pagamento_convertido_pra_r = c(100, 50, 25)
)
detalhe <- data.frame(
  codigo_pagamento = c("A", "A", "B"),
  codigo_favorecido = c("F1", "F2", "F3"),
  valor_do_pagamento_em_r = c(60, 40, 50)
)
encadeia_despesas_ptransp(total, detalhe)
encadeia_despesas_ptransp(total, detalhe, somente_detalhados = TRUE)

---

Obter dados do endpoint plano_acao

Description

Esta função acessa os dados do endpoint **plano_acao** da API FundoaFundo (TransfereGov) utilizando a função interna pg_get. Em vez de inserir o endpoint na URL, utiliza-se o parâmetro table = "plano_acao" para especificar a tabela a ser consultada. Os filtros são aplicados por meio do argumento filter e devem estar no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Usage

get_plano_acao(
  id_plano_acao = NULL,
  codigo_plano_acao = NULL,
  data_inicio_vigencia_plano_acao = NULL,
  data_fim_vigencia_plano_acao = NULL,
  diagnostico_plano_acao = NULL,
  objetivos_plano_acao = NULL,
  situacao_plano_acao = NULL,
  valor_repasse_emenda_plano_acao = NULL,
  valor_repasse_especifico_plano_acao = NULL,
  valor_repasse_voluntario_plano_acao = NULL,
  valor_total_repasse_plano_acao = NULL,
  valor_recursos_proprios_plano_acao = NULL,
  valor_outros_plano_acao = NULL,
  valor_rendimentos_aplicacao_plano_acao = NULL,
  valor_total_plano_acao = NULL,
  valor_total_investimento_plano_acao = NULL,
  valor_total_custeio_plano_acao = NULL,
  valor_saldo_disponivel_plano_acao = NULL,
  id_orgao_repassador_plano_acao = NULL,
  sigla_orgao_repassador_plano_acao = NULL,
  cnpj_orgao_repassador_plano_acao = NULL,
  nome_orgao_repassador_plano_acao = NULL,
  id_ente_repassador_plano_acao = NULL,
  cnpj_ente_repassador_plano_acao = NULL,
  nome_ente_repassador_plano_acao = NULL,
  uf_ente_repassador_plano_acao = NULL,
  nome_municipio_ente_repassador_plano_acao = NULL,
  codigo_ibge_municipio_ente_repassador_plano_acao = NULL,
  id_ente_recebedor_plano_acao = NULL,
  cnpj_ente_recebedor_plano_acao = NULL,
  nome_ente_recebedor_plano_acao = NULL,
  uf_ente_recebedor_plano_acao = NULL,
  nome_municipio_ente_recebedor_plano_acao = NULL,
  codigo_ibge_municipio_ente_recebedor_plano_acao = NULL,
  id_fundo_repassador_plano_acao = NULL,
  cnpj_fundo_repassador_plano_acao = NULL,
  nome_fundo_repassador_plano_acao = NULL,
  uf_fundo_repassador_plano_acao = NULL,
  municipio_fundo_repassador_plano_acao = NULL,
  codigo_ibge_fundo_repassador_plano_acao = NULL,
  id_fundo_recebedor_plano_acao = NULL,
  cnpj_fundo_recebedor_plano_acao = NULL,
  nome_fundo_recebedor_plano_acao = NULL,
  uf_fundo_recebedor_plano_acao = NULL,
  municipio_fundo_recebedor_plano_acao = NULL,
  codigo_ibge_fundo_recebedor_plano_acao = NULL,
  id_programa = NULL,
  select = NULL,
  order = NULL
)

Arguments

id_plano_acao	Identificador do plano de ação (numérico).
codigo_plano_acao	Código do plano de ação (texto).
data_inicio_vigencia_plano_acao	Data de início de vigência do plano de ação (formato YYYY-MM-DD).
data_fim_vigencia_plano_acao	Data de fim de vigência do plano de ação (formato YYYY-MM-DD).
diagnostico_plano_acao	Diagnóstico do plano de ação (texto).
objetivos_plano_acao	Objetivos do plano de ação (texto).
situacao_plano_acao	Situação do plano de ação (texto).
valor_repasse_emenda_plano_acao	Valor de repasse por emenda (numérico).
valor_repasse_especifico_plano_acao	Valor de repasse específico (numérico).
valor_repasse_voluntario_plano_acao	Valor de repasse voluntário (numérico).
valor_total_repasse_plano_acao	Valor total de repasse (numérico).
valor_recursos_proprios_plano_acao	Valor de recursos próprios (numérico).
valor_outros_plano_acao	Valor de outros repasses (numérico).
valor_rendimentos_aplicacao_plano_acao	Valor de rendimentos de aplicação (numérico).
valor_total_plano_acao	Valor total do plano de ação (numérico).
valor_total_investimento_plano_acao	Valor total de investimento (numérico).
valor_total_custeio_plano_acao	Valor total de custeio (numérico).
valor_saldo_disponivel_plano_acao	Valor do saldo disponível (numérico).
id_orgao_repassador_plano_acao	Identificador do órgão repassador (numérico).
sigla_orgao_repassador_plano_acao	Sigla do órgão repassador (texto).
cnpj_orgao_repassador_plano_acao	CNPJ do órgão repassador (texto).
nome_orgao_repassador_plano_acao	Nome do órgão repassador (texto).
id_ente_repassador_plano_acao	Identificador do ente repassador (numérico).
cnpj_ente_repassador_plano_acao	CNPJ do ente repassador (texto).
nome_ente_repassador_plano_acao	Nome do ente repassador (texto).
uf_ente_repassador_plano_acao	UF do ente repassador (texto).
nome_municipio_ente_repassador_plano_acao	Nome do município do ente repassador (texto).
codigo_ibge_municipio_ente_repassador_plano_acao	Código IBGE do município do ente repassador (texto ou numérico).
id_ente_recebedor_plano_acao	Identificador do ente recebedor (numérico).
cnpj_ente_recebedor_plano_acao	CNPJ do ente recebedor (texto).
nome_ente_recebedor_plano_acao	Nome do ente recebedor (texto).
uf_ente_recebedor_plano_acao	UF do ente recebedor (texto).
nome_municipio_ente_recebedor_plano_acao	Nome do município do ente recebedor (texto).
codigo_ibge_municipio_ente_recebedor_plano_acao	Código IBGE do município do ente recebedor (texto ou numérico).
id_fundo_repassador_plano_acao	Identificador do fundo repassador (numérico).
cnpj_fundo_repassador_plano_acao	CNPJ do fundo repassador (texto).
nome_fundo_repassador_plano_acao	Nome do fundo repassador (texto).
uf_fundo_repassador_plano_acao	UF do fundo repassador (texto).
municipio_fundo_repassador_plano_acao	Município do fundo repassador (texto).
codigo_ibge_fundo_repassador_plano_acao	Código IBGE do fundo repassador (texto ou numérico).
id_fundo_recebedor_plano_acao	Identificador do fundo recebedor (numérico).
cnpj_fundo_recebedor_plano_acao	CNPJ do fundo recebedor (texto).
nome_fundo_recebedor_plano_acao	Nome do fundo recebedor (texto).
uf_fundo_recebedor_plano_acao	UF do fundo recebedor (texto).
municipio_fundo_recebedor_plano_acao	Município do fundo recebedor (texto).
codigo_ibge_fundo_recebedor_plano_acao	Código IBGE do fundo recebedor (texto ou numérico).
id_programa	Identificador do programa ao qual o plano de ação está vinculado (numérico).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Value

Um objeto contendo os dados retornados pela API (geralmente uma lista ou data.frame).

Examples

# Exemplo: consultar planos de ação para um programa específico
  plano <- get_plano_acao(id_programa = 1234)
  head(plano)

---

Obter dados do endpoint plano_acao_dado_bancario

Description

Esta função acessa os dados do endpoint **plano_acao_dado_bancario** da API FundoaFundo (TransfereGov) utilizando a função interna pg_get. Em vez de inserir o endpoint na URL, utiliza-se o parâmetro table = "plano_acao_dado_bancario" para especificar a tabela a ser consultada. Os filtros são aplicados por meio do argumento filter e devem estar no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Usage

get_plano_acao_dado_bancario(
  id_plano_acao_dado_bancario = NULL,
  id_agencia_conta = NULL,
  codigo_banco_plano_acao_dado_bancario = NULL,
  nome_banco_plano_acao_dado_bancario = NULL,
  numero_agencia_plano_acao_dado_bancario = NULL,
  dv_agencia_plano_acao_dado_bancario = NULL,
  numero_conta_plano_acao_dado_bancario = NULL,
  dv_conta_plano_acao_dado_bancario = NULL,
  situacao_conta_plano_acao_dado_bancario = NULL,
  data_abertura_conta_plano_acao_dado_bancario = NULL,
  nome_programa_agil_conta_plano_acao_dado_bancario = NULL,
  saldo_final_conta_plano_acao_dado_bancario = NULL,
  id_plano_acao = NULL,
  select = NULL,
  order = NULL
)

Arguments

id_plano_acao_dado_bancario	Identificador do dado bancário do plano de ação (numérico).
id_agencia_conta	Identificador da agência/conta (numérico).
codigo_banco_plano_acao_dado_bancario	Código do banco (texto).
nome_banco_plano_acao_dado_bancario	Nome do banco (texto).
numero_agencia_plano_acao_dado_bancario	Número da agência (texto ou numérico).
dv_agencia_plano_acao_dado_bancario	Dígito verificador da agência (texto).
numero_conta_plano_acao_dado_bancario	Número da conta (texto ou numérico).
dv_conta_plano_acao_dado_bancario	Dígito verificador da conta (texto).
situacao_conta_plano_acao_dado_bancario	Situação da conta (texto).
data_abertura_conta_plano_acao_dado_bancario	Data de abertura da conta (formato YYYY-MM-DD).
nome_programa_agil_conta_plano_acao_dado_bancario	Nome do programa ágil associado à conta (texto).
saldo_final_conta_plano_acao_dado_bancario	Saldo final da conta (numérico).
id_plano_acao	Identificador do plano de ação ao qual o dado bancário está vinculado (numérico).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Value

Um objeto contendo os dados retornados pela API (geralmente uma lista ou data.frame).

Examples

# Exemplo: consultar dados bancários para um plano de ação específico
  dados_bancarios <- get_plano_acao_dado_bancario(id_plano_acao = 1234)
  head(dados_bancarios)

---

Obter dados do endpoint plano_acao_destinacao_recursos

Description

Esta função acessa os dados do endpoint **plano_acao_destinacao_recursos** da API FundoaFundo (TransfereGov) utilizando a função interna pg_get. Em vez de incorporar o endpoint na URL, utiliza-se o parâmetro table = "plano_acao_destinacao_recursos" para especificar a tabela a ser consultada. Os filtros são aplicados por meio do argumento filter e devem estar no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Usage

get_plano_acao_destinacao_recursos(
  id_destinacao_recursos_plano_acao = NULL,
  codigo_natureza_despesa_destinacao_recursos_plano_acao = NULL,
  descricao_natureza_despesa_destinacao_recursos_plano_acao = NULL,
  tipo_despesa_destinacao_recursos_plano_acao = NULL,
  valor_destinacao_recursos_plano_acao = NULL,
  id_plano_acao = NULL,
  select = NULL,
  order = NULL
)

Arguments

id_destinacao_recursos_plano_acao	Identificador da destinacão de recursos do plano de ação (numérico).
codigo_natureza_despesa_destinacao_recursos_plano_acao	Código da natureza de despesa (texto ou numérico).
descricao_natureza_despesa_destinacao_recursos_plano_acao	Descrição da natureza de despesa (texto).
tipo_despesa_destinacao_recursos_plano_acao	Tipo de despesa da destinacão de recursos (texto).
valor_destinacao_recursos_plano_acao	Valor destinado (numérico).
id_plano_acao	Identificador do plano de ação ao qual a destinacão de recursos está vinculada (numérico).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Value

Um objeto contendo os dados retornados pela API (geralmente uma lista ou data.frame).

Examples

# Exemplo: consultar destinacões de recursos para um determinado plano de ação
  dest_recursos <- get_plano_acao_destinacao_recursos(id_plano_acao = 1234)
  head(dest_recursos)

---

Obter dados do endpoint plano_acao_historico

Description

Esta função acessa os dados do endpoint **plano_acao_historico** da API FundoaFundo (TransfereGov) utilizando a função interna pg_get. Em vez de incorporar o endpoint na URL, utiliza-se o parâmetro table = "plano_acao_historico" para especificar a tabela a ser consultada. Os filtros são aplicados por meio do argumento filter e devem estar no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Usage

get_plano_acao_historico(
  id_historico_plano_acao = NULL,
  situacao_historico_plano_acao = NULL,
  data_historico_plano_acao = NULL,
  versao_historico_plano_acao = NULL,
  id_plano_acao = NULL,
  select = NULL,
  order = NULL
)

Arguments

id_historico_plano_acao	Identificador do histórico do plano de ação (numérico).
situacao_historico_plano_acao	Situação do histórico do plano de ação (texto).
data_historico_plano_acao	Data do histórico do plano de ação (formato YYYY-MM-DD).
versao_historico_plano_acao	Versão do histórico do plano de ação (texto ou numérico).
id_plano_acao	Identificador do plano de ação ao qual o histórico está vinculado (numérico).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Value

Um objeto contendo os dados retornados pela API (geralmente uma lista ou data.frame).

Examples

# Exemplo: consultar o histórico de um plano de ação específico
  historico <- get_plano_acao_historico(id_plano_acao = 1234)
  head(historico)

---

Obter dados do endpoint termo_adesao

Description

Esta função acessa os dados do endpoint **termo_adesao** da API FundoaFundo (TransfereGov) utilizando a função interna pg_get. Em vez de incorporar o endpoint na URL, utiliza-se o parâmetro table = "termo_adesao" para especificar a tabela a ser consultada. Os filtros são aplicados por meio do argumento filter e devem estar no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Usage

get_termo_adesao(
  id_termo_adesao = NULL,
  numero_processo_termo_adesao = NULL,
  situacao_termo_adesao = NULL,
  objeto_termo_adesao = NULL,
  data_assinatura_termo_adesao = NULL,
  ano_termo_adesao = NULL,
  secao_publicacao_dou_termo_adesao = NULL,
  pagina_publicacao_dou_termo_adesao = NULL,
  data_publicacao_dou_termo_adesao = NULL,
  id_plano_acao = NULL,
  select = NULL,
  order = NULL
)

Arguments

id_termo_adesao	Identificador do termo de adesão (numérico).
numero_processo_termo_adesao	Número do processo do termo de adesão (texto).
situacao_termo_adesao	Situação do termo de adesão (texto).
objeto_termo_adesao	Objeto do termo de adesão (texto).
data_assinatura_termo_adesao	Data de assinatura do termo de adesão (formato YYYY-MM-DD).
ano_termo_adesao	Ano do termo de adesão (numérico).
secao_publicacao_dou_termo_adesao	Seção da publicação no DOU do termo de adesão (texto).
pagina_publicacao_dou_termo_adesao	Página da publicação no DOU do termo de adesão (texto ou numérico).
data_publicacao_dou_termo_adesao	Data da publicação no DOU do termo de adesão (formato YYYY-MM-DD).
id_plano_acao	Identificador do plano de ação ao qual o termo de adesão está vinculado (numérico).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Value

Um objeto contendo os dados retornados pela API (geralmente uma lista ou data.frame).

Examples

# Exemplo: consultar termos de adesão para um plano de ação específico
  termo <- get_termo_adesao(id_plano_acao = 1234)
  head(termo)

---

Ler dados do endpoint empenho

Description

Esta função acessa os dados do endpoint **empenho** da API FundoaFundo (TransfereGov) utilizando a função interna pg_get. Em vez de incorporar o endpoint na URL, utiliza-se o parâmetro table = "empenho" para especificar a tabela a ser consultada. Os filtros são aplicados por meio do argumento filter e devem estar no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Usage

ler_empenho(
  id_empenho = NULL,
  numero_empenho = NULL,
  ano_empenho = NULL,
  gestao_emitente_empenho = NULL,
  ug_emitente_empenho = NULL,
  data_emissao_empenho = NULL,
  fonte_recurso_empenho = NULL,
  esfera_orcamentaria_empenho = NULL,
  descricao_esfera_orcamentaria_empenho = NULL,
  plano_interno_empenho = NULL,
  unidade_gestora_responsavel_empenho = NULL,
  observacao_empenho = NULL,
  cnpj_favorecido_empenho = NULL,
  numero_lista_empenho = NULL,
  unidade_gestora_referencia_empenho = NULL,
  gestao_referencia_empenho = NULL,
  numero_interno_empenho = NULL,
  objeto_empenho = NULL,
  numero_sistema_empenho = NULL,
  natureza_despesa_empenho = NULL,
  natureza_despesa_sub_item_empenho = NULL,
  tipo_empenho = NULL,
  descricao_tipo_empenho = NULL,
  codigo_tipo_nota_empenho = NULL,
  descricao_tipo_nota_empenho = NULL,
  situacao_empenho = NULL,
  descricao_situacao_empenho = NULL,
  valor_empenho = NULL,
  versao_empenho = NULL,
  id_plano_acao = NULL,
  select = NULL,
  order = NULL
)

Arguments

id_empenho	Identificador do empenho (numérico).
numero_empenho	Número do empenho (texto ou numérico).
ano_empenho	Ano do empenho (numérico).
gestao_emitente_empenho	Gestão emitente do empenho (texto).
ug_emitente_empenho	Unidade gestora emitente do empenho (texto).
data_emissao_empenho	Data de emissão do empenho (formato YYYY-MM-DD).
fonte_recurso_empenho	Fonte de recurso do empenho (texto).
esfera_orcamentaria_empenho	Esfera orçamentária do empenho (texto).
descricao_esfera_orcamentaria_empenho	Descrição da esfera orçamentária (texto).
plano_interno_empenho	Plano interno do empenho (texto).
unidade_gestora_responsavel_empenho	Unidade gestora responsável pelo empenho (texto).
observacao_empenho	Observação sobre o empenho (texto).
cnpj_favorecido_empenho	CNPJ do favorecido do empenho (texto).
numero_lista_empenho	Número da lista do empenho (texto ou numérico).
unidade_gestora_referencia_empenho	Unidade gestora de referência do empenho (texto).
gestao_referencia_empenho	Gestão de referência do empenho (texto).
numero_interno_empenho	Número interno do empenho (texto ou numérico).
objeto_empenho	Objeto do empenho (texto).
numero_sistema_empenho	Número do sistema do empenho (texto ou numérico).
natureza_despesa_empenho	Natureza da despesa do empenho (texto).
natureza_despesa_sub_item_empenho	Subitem da natureza de despesa do empenho (texto).
tipo_empenho	Tipo do empenho (texto).
descricao_tipo_empenho	Descrição do tipo de empenho (texto).
codigo_tipo_nota_empenho	Código do tipo de nota do empenho (texto ou numérico).
descricao_tipo_nota_empenho	Descrição do tipo de nota do empenho (texto).
situacao_empenho	Situação do empenho (texto).
descricao_situacao_empenho	Descrição da situação do empenho (texto).
valor_empenho	Valor do empenho (numérico).
versao_empenho	Versão do empenho (texto ou numérico).
id_plano_acao	Identificador do plano de ação ao qual o empenho está vinculado (numérico).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Value

Um objeto contendo os dados retornados pela API (geralmente uma lista ou data.frame).

Examples

# Exemplo: ler empenhos do ano de 2020 para um determinado plano de ação
  empenhos <- ler_empenho(ano_empenho = 2020, id_plano_acao = 1234)
  head(empenhos)

---

Ler dados de Empenho Especial da API TransfereGov

Description

Esta função acessa os dados do endpoint **empenho_especial** da API FundoaFundo (TransfereGov) utilizando a função interna pg_get. Os filtros são aplicados por meio do argumento filter e devem estar no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Usage

ler_empenho_especial(
  id_empenho_especial = NULL,
  numero_empenho = NULL,
  ano_empenho = NULL,
  id_programa = NULL,
  cnpj_favorecido_empenho = NULL,
  valor_empenho = NULL,
  data_emissao_empenho = NULL,
  tipo_empenho = NULL,
  situacao_empenho = NULL,
  ug_emitente_empenho = NULL,
  objeto_empenho = NULL,
  select = NULL,
  order = NULL
)

Arguments

id_empenho_especial	Identificador único do empenho especial (numérico).
numero_empenho	Número do empenho (texto ou numérico).
ano_empenho	Ano do empenho (numérico).
id_programa	Identificador do programa especial ao qual o empenho está vinculado (numérico).
cnpj_favorecido_empenho	CNPJ do favorecido do empenho (texto).
valor_empenho	Valor do empenho (numérico).
data_emissao_empenho	Data de emissão do empenho (formato YYYY-MM-DD).
tipo_empenho	Tipo do empenho especial (texto).
situacao_empenho	Situação do empenho (e.g., "Liquidado", "Pago") (texto).
ug_emitente_empenho	Unidade gestora emitente do empenho (texto).
objeto_empenho	Objeto do empenho (texto).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Value

Um objeto contendo os dados retornados pela API (geralmente um data.frame).

Examples

## Not run: 
  # Exemplo: ler empenhos especiais do ano de 2023
  empenhos_especiais_2023 <- ler_empenho_especial(ano_empenho = 2023)
  head(empenhos_especiais_2023)

  # Exemplo: ler empenhos especiais vinculados a um programa específico
  empenhos_de_programa <- ler_empenho_especial(id_programa = 12345, ano_empenho = 2022)
  head(empenhos_de_programa)

## End(Not run)

---

Obter dados do endpoint gestao_financeira_categorias_despesa

Description

Esta função acessa os dados do endpoint **gestao_financeira_categorias_despesa** da API FundoaFundo (TransfereGov) utilizando a função interna pg_get. Em vez de incorporar o endpoint na URL, utiliza-se o parâmetro table = "gestao_financeira_categorias_despesa" para especificar a tabela a ser consultada. Os filtros são aplicados por meio do argumento filter e devem estar no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Usage

ler_gestao_financeira_categorias_despesa(
  id_categoria_despesa_gestao_financeira = NULL,
  id_nivel_pai_categoria_despesa_gestao_financeira = NULL,
  nome_nivel_atual_categoria_despesa_gestao_financeira = NULL,
  nivel_atual_categoria_despesa_gestao_financeira = NULL,
  nome_completo_niveis_categoria_despesa_gestao_financeira = NULL,
  codigo_programa_agil = NULL,
  nome_programa_agil = NULL,
  select = NULL,
  order = NULL
)

Arguments

id_categoria_despesa_gestao_financeira	Identificador da categoria de despesa (numérico).
id_nivel_pai_categoria_despesa_gestao_financeira	Identificador do nível pai da categoria de despesa (numérico).
nome_nivel_atual_categoria_despesa_gestao_financeira	Nome do nível atual da categoria de despesa (texto).
nivel_atual_categoria_despesa_gestao_financeira	Nível atual da categoria de despesa (texto ou numérico).
nome_completo_niveis_categoria_despesa_gestao_financeira	Nome completo dos níveis da categoria de despesa (texto).
codigo_programa_agil	Código do programa ágil associado (texto ou numérico).
nome_programa_agil	Nome do programa ágil associado (texto).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Value

Um objeto contendo os dados retornados pela API (geralmente uma lista ou data.frame).

Examples

# Exemplo: consultar categorias de despesa para um programa ágil específico
  categorias <- ler_gestao_financeira_categorias_despesa(
    codigo_programa_agil = "001",
    nome_programa_agil = "Programa Exemplo"
  )
  head(categorias)

---

Obter dados do endpoint gestao_financeira_lancamentos

Description

Esta função acessa os dados do endpoint **gestao_financeira_lancamentos** da API FundoaFundo (TransfereGov) utilizando a função interna pg_get. Em vez de incorporar o endpoint na URL, utiliza-se o parâmetro table = "gestao_financeira_lancamentos" para especificar a tabela a ser consultada. Os filtros são aplicados por meio do argumento filter e devem estar no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Usage

ler_gestao_financeira_lancamentos(
  id_lancamento_gestao_financeira = NULL,
  origem_solicitacao_gestao_financeira = NULL,
  descricao_origem_solicitacao_gestao_financeira = NULL,
  cnpj_ente_solicitante_gestao_financeira = NULL,
  nome_ente_solicitante_gestao_financeira = NULL,
  nome_personalizado_ente_solicitante_gestao_financeira = NULL,
  codigo_programa_agil_ente_solicitante_gestao_financeira = NULL,
  codigo_banco_gestao_financeira = NULL,
  codigo_agencia_gestao_financeira = NULL,
  dv_agencia_gestao_financeira = NULL,
  codigo_conta_gestao_financeira = NULL,
  dv_conta_gestao_financeira = NULL,
  tipo_operacao_gestao_financeira = NULL,
  descricao_tipo_operacao_gestao_financeira = NULL,
  descricao_gestao_financeira = NULL,
  data_lancamento_gestao_financeira = NULL,
  data_evento_lancamento_gestao_financeira = NULL,
  numero_ordem_gestao_financeira = NULL,
  numero_referencia_unica_gestao_financeira = NULL,
  tipo_favorecido_gestao_financeira = NULL,
  descricao_tipo_favorecido_gestao_financeira = NULL,
  doc_favorecido_gestao_financeira_mask = NULL,
  nome_favorecido_gestao_financeira = NULL,
  codigo_banco_favorecido_gestao_financeira = NULL,
  codigo_agencia_favorecido_gestao_financeira = NULL,
  dv_agencia_favorecido_gestao_financeira = NULL,
  codigo_conta_favorecido_gestao_financeira = NULL,
  dv_conta_favorecido_gestao_financeira = NULL,
  valor_lancamento_gestao_financeira = NULL,
  id_categoria_despesa_gestao_financeira = NULL,
  quantidade_subtransacoes_lancamento_gestao_financeira = NULL,
  id_agencia_conta = NULL,
  select = NULL,
  order = NULL
)

Arguments

id_lancamento_gestao_financeira	Identificador do lançamento (numérico).
origem_solicitacao_gestao_financeira	Origem da solicitação (texto).
descricao_origem_solicitacao_gestao_financeira	Descrição da origem da solicitação (texto).
cnpj_ente_solicitante_gestao_financeira	CNPJ do ente solicitante (texto).
nome_ente_solicitante_gestao_financeira	Nome do ente solicitante (texto).
nome_personalizado_ente_solicitante_gestao_financeira	Nome personalizado do ente solicitante (texto).
codigo_programa_agil_ente_solicitante_gestao_financeira	Código do programa ágil do ente solicitante (texto).
codigo_banco_gestao_financeira	Código do banco (texto ou numérico).
codigo_agencia_gestao_financeira	Código da agência (texto ou numérico).
dv_agencia_gestao_financeira	Dígito verificador da agência (texto).
codigo_conta_gestao_financeira	Código da conta (texto ou numérico).
dv_conta_gestao_financeira	Dígito verificador da conta (texto).
tipo_operacao_gestao_financeira	Tipo de operação (texto).
descricao_tipo_operacao_gestao_financeira	Descrição do tipo de operação (texto).
descricao_gestao_financeira	Descrição da gestão financeira (texto).
data_lancamento_gestao_financeira	Data do lançamento (formato YYYY-MM-DD).
data_evento_lancamento_gestao_financeira	Data do evento do lançamento (formato YYYY-MM-DD).
numero_ordem_gestao_financeira	Número da ordem (numérico).
numero_referencia_unica_gestao_financeira	Número de referência única (texto ou numérico).
tipo_favorecido_gestao_financeira	Tipo de favorecido (texto).
descricao_tipo_favorecido_gestao_financeira	Descrição do tipo de favorecido (texto).
doc_favorecido_gestao_financeira_mask	Documento do favorecido (texto mascarado).
nome_favorecido_gestao_financeira	Nome do favorecido (texto).
codigo_banco_favorecido_gestao_financeira	Código do banco do favorecido (texto ou numérico).
codigo_agencia_favorecido_gestao_financeira	Código da agência do favorecido (texto ou numérico).
dv_agencia_favorecido_gestao_financeira	Dígito verificador da agência do favorecido (texto).
codigo_conta_favorecido_gestao_financeira	Código da conta do favorecido (texto ou numérico).
dv_conta_favorecido_gestao_financeira	Dígito verificador da conta do favorecido (texto).
valor_lancamento_gestao_financeira	Valor do lançamento (numérico).
id_categoria_despesa_gestao_financeira	Identificador da categoria de despesa (numérico).
quantidade_subtransacoes_lancamento_gestao_financeira	Quantidade de subtransações (numérico).
id_agencia_conta	Identificador da agência/conta (numérico).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Value

Um objeto contendo os dados retornados pela API (geralmente uma lista ou data.frame).

Examples

# Exemplo: consultar lançamentos de gestão financeira para um determinado ente solicitante
  lancamentos <- ler_gestao_financeira_lancamentos(
    cnpj_ente_solicitante_gestao_financeira = "12.345.678/0001-99"
  )
  head(lancamentos)

---

Obter dados do endpoint gestao_financeira_subtransacoes

Description

Esta função acessa os dados do endpoint **gestao_financeira_subtransacoes** da API FundoaFundo (TransfereGov) utilizando a função interna pg_get. Em vez de inserir o endpoint na URL, utiliza-se o parâmetro table = "gestao_financeira_subtransacoes" para especificar a tabela a ser consultada. Os filtros são aplicados por meio do argumento filter e devem estar no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Usage

ler_gestao_financeira_subtransacoes(
  id_subtransacao_gestao_financeira = NULL,
  estado_subtransacao_gestao_financeira = NULL,
  situacao_pagamento_subtransacao_gestao_financeira = NULL,
  descricao_situacao_pagamento_subtransacao_gestao_financeira = NULL,
  data_pagamento_subtransacao_gestao_financeira = NULL,
  tipo_pessoa_beneficiario_subtransacao_gestao_financeira = NULL,
  descricao_tipo_pessoa_beneficiario_subtransacao_gestao_financei = NULL,
  numero_documento_beneficiario_subtransacao_gestao_financeira_ma = NULL,
  nome_beneficiario_subtransacao_gestao_financeira = NULL,
  codigo_banco_beneficiario_subtransacao_gestao_financeira = NULL,
  codigo_agencia_beneficiario_subtransacao_gestao_financeira = NULL,
  codigo_conta_beneficiario_subtransacao_gestao_financeira = NULL,
  descricao_subtransacao_gestao_financeira = NULL,
  valor_subtransacao_gestao_financeira = NULL,
  id_categoria_despesa_gestao_financeira = NULL,
  id_lancamento_gestao_financeira = NULL,
  data_evento_lancamento_gestao_financeira = NULL,
  numero_ordem_gestao_financeira = NULL,
  numero_referencia_unica_gestao_financeira = NULL,
  tipo_favorecido_gestao_financeira = NULL,
  descricao_tipo_favorecido_gestao_financeira = NULL,
  doc_favorecido_gestao_financeira_mask = NULL,
  nome_favorecido_gestao_financeira = NULL,
  codigo_banco_favorecido_gestao_financeira = NULL,
  codigo_agencia_favorecido_gestao_financeira = NULL,
  dv_agencia_favorecido_gestao_financeira = NULL,
  codigo_conta_favorecido_gestao_financeira = NULL,
  dv_conta_favorecido_gestao_financeira = NULL,
  valor_lancamento_gestao_financeira = NULL,
  quantidade_subtransacoes_lancamento_gestao_financeira = NULL,
  id_agencia_conta = NULL,
  select = NULL,
  order = NULL
)

Arguments

id_subtransacao_gestao_financeira	Identificador da subtransação (numérico).
estado_subtransacao_gestao_financeira	Estado da subtransação (texto).
situacao_pagamento_subtransacao_gestao_financeira	Situação do pagamento (texto).
descricao_situacao_pagamento_subtransacao_gestao_financeira	Descrição da situação de pagamento (texto).
data_pagamento_subtransacao_gestao_financeira	Data de pagamento (formato YYYY-MM-DD).
tipo_pessoa_beneficiario_subtransacao_gestao_financeira	Tipo de pessoa beneficiária (texto).
descricao_tipo_pessoa_beneficiario_subtransacao_gestao_financei	Descrição do tipo de pessoa beneficiária (texto).
numero_documento_beneficiario_subtransacao_gestao_financeira_ma	Número do documento do beneficiário (texto).
nome_beneficiario_subtransacao_gestao_financeira	Nome do beneficiário (texto).
codigo_banco_beneficiario_subtransacao_gestao_financeira	Código do banco do beneficiário (texto ou numérico).
codigo_agencia_beneficiario_subtransacao_gestao_financeira	Código da agência do beneficiário (texto ou numérico).
codigo_conta_beneficiario_subtransacao_gestao_financeira	Código da conta do beneficiário (texto ou numérico).
descricao_subtransacao_gestao_financeira	Descrição da subtransação (texto).
valor_subtransacao_gestao_financeira	Valor da subtransação (numérico).
id_categoria_despesa_gestao_financeira	Identificador da categoria de despesa (numérico).
id_lancamento_gestao_financeira	Identificador do lançamento de gestão financeira (numérico).
data_evento_lancamento_gestao_financeira	Data do evento do lançamento (formato YYYY-MM-DD).
numero_ordem_gestao_financeira	Número da ordem (numérico).
numero_referencia_unica_gestao_financeira	Número de referência única (texto ou numérico).
tipo_favorecido_gestao_financeira	Tipo de favorecido (texto).
descricao_tipo_favorecido_gestao_financeira	Descrição do tipo de favorecido (texto).
doc_favorecido_gestao_financeira_mask	Documento do favorecido (texto mascarado).
nome_favorecido_gestao_financeira	Nome do favorecido (texto).
codigo_banco_favorecido_gestao_financeira	Código do banco do favorecido (texto ou numérico).
codigo_agencia_favorecido_gestao_financeira	Código da agência do favorecido (texto ou numérico).
dv_agencia_favorecido_gestao_financeira	Dígito verificador da agência do favorecido (texto).
codigo_conta_favorecido_gestao_financeira	Código da conta do favorecido (texto ou numérico).
dv_conta_favorecido_gestao_financeira	Dígito verificador da conta do favorecido (texto).
valor_lancamento_gestao_financeira	Valor do lançamento (numérico).
quantidade_subtransacoes_lancamento_gestao_financeira	Quantidade de subtransações (numérico).
id_agencia_conta	Identificador da agência/conta (numérico).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Value

Um objeto contendo os dados retornados pela API (geralmente uma lista ou data.frame).

Examples

# Exemplo: consultar subtransações para um lançamento de gestão financeira específico
  subtransacoes <- ler_gestao_financeira_subtransacoes(id_lancamento_gestao_financeira = 1234)
  head(subtransacoes)

---

Obter dados do endpoint plano_acao_analise

Description

Esta função acessa os dados do endpoint **plano_acao_analise** da API FundoaFundo (TransfereGov) utilizando a função interna pg_get. Em vez de incorporar o endpoint na URL, utiliza-se o parâmetro table = "plano_acao_analise" para especificar a tabela a ser consultada. Os filtros são aplicados por meio do argumento filter e devem estar no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Usage

ler_plano_acao_analise(
  id_analise_plano_acao = NULL,
  tipo_analise_plano_acao = NULL,
  tipo_analise_resultado_plano_acao = NULL,
  data_analise_plano_acao = NULL,
  parecer_analise_plano_acao = NULL,
  tipo_origem_analise_plano_acao = NULL,
  id_plano_acao = NULL,
  id_historico_plano_acao = NULL,
  select = NULL,
  order = NULL
)

Arguments

id_analise_plano_acao	Identificador da análise do plano de ação (numérico).
tipo_analise_plano_acao	Tipo da análise do plano de ação (texto).
tipo_analise_resultado_plano_acao	Tipo do resultado da análise do plano de ação (texto).
data_analise_plano_acao	Data da análise do plano de ação (formato YYYY-MM-DD).
parecer_analise_plano_acao	Parecer da análise do plano de ação (texto).
tipo_origem_analise_plano_acao	Tipo de origem da análise do plano de ação (texto).
id_plano_acao	Identificador do plano de ação ao qual a análise está vinculada (numérico).
id_historico_plano_acao	Identificador do histórico do plano de ação (numérico).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Value

Um objeto contendo os dados retornados pela API (geralmente uma lista ou data.frame).

Examples

# Exemplo: consultar análises de plano de ação para um plano específico
  analise <- ler_plano_acao_analise(id_plano_acao = 1234)
  head(analise)

---

Obter dados do endpoint plano_acao_analise_responsavel

Description

Esta função acessa os dados do endpoint **plano_acao_analise_responsavel** da API FundoaFundo (TransfereGov) utilizando a função interna pg_get. Em vez de incorporar o endpoint na URL, utiliza-se o parâmetro table = "plano_acao_analise_responsavel" para especificar a tabela a ser consultada. Os filtros são aplicados por meio do argumento filter e devem estar no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Usage

ler_plano_acao_analise_responsavel(
  plano_acao_analise_fk = NULL,
  nome_responsavel_analise_plano_acao = NULL,
  cargo_responsavel_analise_plano_acao = NULL,
  select = NULL,
  order = NULL
)

Arguments

plano_acao_analise_fk	Chave estrangeira que referencia a análise do plano de ação (numérico).
nome_responsavel_analise_plano_acao	Nome do responsável pela análise do plano de ação (texto).
cargo_responsavel_analise_plano_acao	Cargo do responsável pela análise do plano de ação (texto).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Value

Um objeto contendo os dados retornados pela API (geralmente uma lista ou data.frame).

Examples

# Exemplo: consultar os responsáveis pela análise de um plano de ação específico
  resp <- ler_plano_acao_analise_responsavel(plano_acao_analise_fk = 1234)
  head(resp)

---

Obter dados do endpoint plano_acao_meta

Description

Esta função acessa os dados do endpoint **plano_acao_meta** da API FundoaFundo (TransfereGov) utilizando a função interna pg_get. Em vez de incorporar o endpoint na URL, utiliza-se o parâmetro table = "plano_acao_meta" para especificar a tabela a ser consultada.

Usage

ler_plano_acao_meta(
  id_meta_plano_acao = NULL,
  numero_meta_plano_acao = NULL,
  nome_meta_plano_acao = NULL,
  descricao_meta_plano_acao = NULL,
  valor_meta_plano_acao = NULL,
  versao_meta_plano_acao = NULL,
  sequencial_meta_plano_acao = NULL,
  id_plano_acao = NULL,
  select = NULL,
  order = NULL
)

Arguments

id_meta_plano_acao	Identificador da meta do plano de ação (numérico).
numero_meta_plano_acao	Número da meta do plano de ação (texto ou numérico).
nome_meta_plano_acao	Nome da meta do plano de ação (texto).
descricao_meta_plano_acao	Descrição da meta do plano de ação (texto).
valor_meta_plano_acao	Valor da meta do plano de ação (numérico).
versao_meta_plano_acao	Versão da meta do plano de ação (texto ou numérico).
sequencial_meta_plano_acao	Sequencial da meta do plano de ação (numérico).
id_plano_acao	Identificador do plano de ação ao qual a meta está vinculada (numérico).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Details

Os filtros são aplicados por meio do argumento filter da função pg_get. Para cada parâmetro informado, é criada uma condição no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Value

Um objeto contendo os dados retornados pela API (geralmente uma lista ou data.frame).

Examples

# Exemplo: consultar metas de plano de ação para um plano específico
  meta <- ler_plano_acao_meta(id_plano_acao = 1234)
  head(meta)

---

Obter dados do endpoint plano_acao_meta_acao

Description

Esta função acessa os dados do endpoint **plano_acao_meta_acao** da API FundoaFundo (TransfereGov) utilizando a função interna pg_get. Em vez de incorporar o endpoint na URL, utiliza-se o parâmetro table = "plano_acao_meta_acao" para especificar a tabela a ser consultada. Os filtros são aplicados por meio do argumento filter e devem estar no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Usage

ler_plano_acao_meta_acao(
  id_acao_meta_plano_acao = NULL,
  numero_acao_meta_plano_acao = NULL,
  nome_acao_meta_plano_acao = NULL,
  descricao_acao_meta_plano_acao = NULL,
  valor_acao_meta_plano_acao = NULL,
  versao_acao_meta_plano_acao = NULL,
  sequencial_acao_meta_plano_acao = NULL,
  id_meta_plano_acao = NULL,
  select = NULL,
  order = NULL
)

Arguments

id_acao_meta_plano_acao	Identificador da ação da meta do plano de ação (numérico).
numero_acao_meta_plano_acao	Número da ação da meta do plano de ação (texto ou numérico).
nome_acao_meta_plano_acao	Nome da ação da meta do plano de ação (texto).
descricao_acao_meta_plano_acao	Descrição da ação da meta do plano de ação (texto).
valor_acao_meta_plano_acao	Valor da ação da meta do plano de ação (numérico).
versao_acao_meta_plano_acao	Versão da ação da meta do plano de ação (texto ou numérico).
sequencial_acao_meta_plano_acao	Sequencial da ação da meta do plano de ação (numérico).
id_meta_plano_acao	Identificador da meta do plano de ação à qual a ação está vinculada (numérico).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Value

Um objeto contendo os dados retornados pela API (geralmente uma lista ou data.frame).

Examples

# Exemplo: consultar ações de meta para uma meta de plano de ação específica
  acao_meta <- ler_plano_acao_meta_acao(id_meta_plano_acao = 5678)
  head(acao_meta)

---

Obter dados do endpoint programa_beneficiario

Description

Esta função acessa os dados referentes ao endpoint de beneficiários de programas na API FundoaFundo (TransfereGov), utilizando a função interna pg_get. Em vez de inserir o endpoint na URL, utiliza-se o parâmetro table = 'programa_beneficiario' para especificar a tabela a ser consultada.

Usage

ler_programa_beneficiario(
  id_beneficiario_programa = NULL,
  cnpj_beneficiario_programa = NULL,
  nome_beneficiario_programa = NULL,
  valor_beneficiario_programa = NULL,
  numero_emenda_beneficiario_programa = NULL,
  nome_parlamentar_beneficiario_programa = NULL,
  tipo_beneficiario_programa = NULL,
  uf_beneficiario_programa = NULL,
  id_programa = NULL,
  select = NULL,
  order = NULL
)

Arguments

id_beneficiario_programa	Identificador do beneficiário do programa (numérico).
cnpj_beneficiario_programa	CNPJ do beneficiário do programa (texto).
nome_beneficiario_programa	Nome do beneficiário do programa (texto).
valor_beneficiario_programa	Valor atribuído ao beneficiário do programa (numérico).
numero_emenda_beneficiario_programa	Número da emenda do beneficiário do programa (texto ou numérico).
nome_parlamentar_beneficiario_programa	Nome do parlamentar associado ao beneficiário (texto).
tipo_beneficiario_programa	Tipo de beneficiário do programa (texto).
uf_beneficiario_programa	Unidade Federativa do beneficiário do programa (texto).
id_programa	Identificador do programa ao qual o beneficiário está vinculado (numérico).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Details

Os filtros são aplicados por meio do parâmetro filter da função pg_get. Para cada parâmetro informado, é criada uma condição no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Value

Um objeto contendo os dados retornados pela API (geralmente uma lista ou data.frame).

Examples

# Exemplo: consultar beneficiários do programa com id 1234 e UF "SP"
  beneficiarios <- ler_programa_beneficiario(id_programa = 1234, uf_beneficiario_programa = "SP")
  head(beneficiarios)

---

Ler dados de Programa Especial da API TransfereGov

Description

Esta função acessa os dados do endpoint **programa_especial** da API TransfereGov utilizando a função interna pg_get. Os filtros são aplicados por meio do argumento filter e devem estar no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Usage

ler_programa_especial(
  id_programa = NULL,
  ano_programa = NULL,
  nome_programa = NULL,
  situacao_programa = NULL,
  id_proponente = NULL,
  data_inicio = NULL,
  data_fim = NULL,
  esfera = NULL,
  orgao_executor = NULL,
  select = NULL,
  order = NULL
)

Arguments

id_programa	Identificador único do programa especial (numérico).
ano_programa	Ano do programa especial (numérico).
nome_programa	Nome ou descrição do programa especial (texto).
situacao_programa	Situação atual do programa (e.g., "Ativo", "Concluído") (texto).
id_proponente	Identificador do proponente (e.g., CNPJ, CPF) (texto).
data_inicio	Data de início do programa (formato YYYY-MM-DD).
data_fim	Data de fim do programa (formato YYYY-MM-DD).
esfera	Nível da esfera do programa (e.g., "FEDERAL", "ESTADUAL", "MUNICIPAL") (texto).
orgao_executor	Nome ou código do órgão executor do programa (texto).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Value

Um objeto contendo os dados retornados pela API (geralmente um data.frame).

Examples

## Not run: 
  # Exemplo: ler programas especiais do ano de 2022
  programas_2022 <- ler_programa_especial(ano_programa = 2022)
  head(programas_2022)

  # Exemplo: ler programas com um ID específico
  programa_especifico <- ler_programa_especial(id_programa = 12345)
  head(programa_especifico)

## End(Not run)

---

Obter dados do endpoint programa_gestao_agil

Description

Esta função acessa os dados do endpoint **programa_gestao_agil** da API FundoaFundo (TransfereGov) utilizando a função interna pg_get. Em vez de incorporar o endpoint na URL, utiliza-se o parâmetro table = "programa_gestao_agil" para especificar a tabela a ser consultada.

Usage

ler_programa_gestao_agil(
  id_programa_agil = NULL,
  id_programa_agil_bb = NULL,
  nome_programa_agil = NULL,
  codigo_programa_agil = NULL,
  codigo_siorg_orgao_programa_agil = NULL,
  sigla_orgao_programa_agil = NULL,
  cnpj_orgao_programa_agil = NULL,
  nome_orgao_programa_agil = NULL,
  id_programa = NULL,
  select = NULL,
  order = NULL
)

Arguments

id_programa_agil	Identificador do programa ágil (numérico).
id_programa_agil_bb	Identificador do programa ágil BB (numérico).
nome_programa_agil	Nome do programa ágil (texto).
codigo_programa_agil	Código do programa ágil (texto).
codigo_siorg_orgao_programa_agil	Código SIORG do órgão do programa ágil (texto).
sigla_orgao_programa_agil	Sigla do órgão do programa ágil (texto).
cnpj_orgao_programa_agil	CNPJ do órgão do programa ágil (texto).
nome_orgao_programa_agil	Nome do órgão do programa ágil (texto).
id_programa	Identificador do programa ao qual o registro está vinculado (numérico).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Details

Os filtros são aplicados por meio do argumento filter da função pg_get. Para cada parâmetro informado, é criada uma condição no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Value

Um objeto contendo os dados retornados pela API (geralmente uma lista ou data.frame).

Examples

# Exemplo: consultar registros do programa_gestao_agil para um programa específico
  agil <- ler_programa_gestao_agil(id_programa = 1234)
  head(agil)

---

Obter dados do endpoint /programa

Description

Esta função acessa o endpoint '/programa' da API FundoaFundo (TransfereGov) e retorna os dados filtrados de programas, utilizando a função interna pg_get.

Usage

ler_programas(
  id_programa = NULL,
  ano_programa = NULL,
  modalidade_programa = NULL,
  codigo_programa = NULL,
  nome_programa = NULL,
  id_unidade_gestora_programa = NULL,
  nome_institucional_programa = NULL,
  permite_transferencia_sem_fundo_programa = NULL,
  objetivo_programa = NULL,
  descricao_programa = NULL,
  situacao_programa = NULL,
  valor_global_programa = NULL,
  quantidade_parcelas_programa = NULL,
  id_orgao_superior_programa = NULL,
  sigla_orgao_superior_programa = NULL,
  cnpj_orgao_superior_programa = NULL,
  nome_orgao_superior_programa = NULL,
  id_fundo_programa = NULL,
  cnpj_fundo_programa = NULL,
  nome_fundo_programa = NULL,
  uf_fundo_programa = NULL,
  municipio_fundo_programa = NULL,
  codigo_ibge_fundo_programa = NULL,
  grupo_natureza_despesa_programa = NULL,
  codigo_descricao_orcamentaria_programa = NULL,
  descricao_acao_orcamentaria_programa = NULL,
  valor_acao_orcamentaria_programa = NULL,
  data_inicio_recebimento_planos_acao_beneficiarios_especificos = NULL,
  data_fim_recebimento_planos_acao_beneficiarios_especificos = NULL,
  data_inicio_recebimento_planos_acao_beneficiarios_emendas = NULL,
  data_fim_recebimento_planos_acao_beneficiarios_emendas = NULL,
  data_inicio_recebimento_planos_acao_beneficiarios_voluntarios = NULL,
  data_fim_recebimento_planos_acao_beneficiarios_voluntarios = NULL,
  nome_gestao_agil_programa = NULL,
  select = NULL,
  order = NULL
)

Arguments

id_programa	Identificador do programa (numérico).
ano_programa	Ano de referência do programa (numérico).
modalidade_programa	Modalidade ou categoria do programa (texto).
codigo_programa	Código do programa (texto).
nome_programa	Nome do programa (texto).
id_unidade_gestora_programa	Identificador da unidade gestora do programa (numérico).
nome_institucional_programa	Nome institucional do programa (texto).
permite_transferencia_sem_fundo_programa	Indica se o programa permite transferência sem fundo (booleano ou texto).
objetivo_programa	Objetivo do programa (texto).
descricao_programa	Descrição do programa (texto).
situacao_programa	Situação do programa (texto).
valor_global_programa	Valor global do programa (numérico).
quantidade_parcelas_programa	Quantidade de parcelas do programa (numérico).
id_orgao_superior_programa	Identificador do órgão superior do programa (numérico).
sigla_orgao_superior_programa	Sigla do órgão superior (texto).
cnpj_orgao_superior_programa	CNPJ do órgão superior (texto).
nome_orgao_superior_programa	Nome do órgão superior (texto).
id_fundo_programa	Identificador do fundo do programa (numérico).
cnpj_fundo_programa	CNPJ do fundo (texto).
nome_fundo_programa	Nome do fundo (texto).
uf_fundo_programa	Unidade Federativa do fundo (texto).
municipio_fundo_programa	Município do fundo (texto).
codigo_ibge_fundo_programa	Código IBGE do fundo (texto ou numérico).
grupo_natureza_despesa_programa	Grupo de natureza de despesa do programa (texto).
codigo_descricao_orcamentaria_programa	Código ou descrição orçamentária do programa (texto).
descricao_acao_orcamentaria_programa	Descrição da ação orçamentária (texto).
valor_acao_orcamentaria_programa	Valor da ação orçamentária (numérico).
data_inicio_recebimento_planos_acao_beneficiarios_especificos	Data de início do recebimento de planos de ação para beneficiários específicos (formato YYYY-MM-DD).
data_fim_recebimento_planos_acao_beneficiarios_especificos	Data de fim do recebimento de planos de ação para beneficiários específicos (formato YYYY-MM-DD).
data_inicio_recebimento_planos_acao_beneficiarios_emendas	Data de início do recebimento de planos de ação para beneficiários de emendas (formato YYYY-MM-DD).
data_fim_recebimento_planos_acao_beneficiarios_emendas	Data de fim do recebimento de planos de ação para beneficiários de emendas (formato YYYY-MM-DD).
data_inicio_recebimento_planos_acao_beneficiarios_voluntarios	Data de início do recebimento de planos de ação para beneficiários voluntários (formato YYYY-MM-DD).
data_fim_recebimento_planos_acao_beneficiarios_voluntarios	Data de fim do recebimento de planos de ação para beneficiários voluntários (formato YYYY-MM-DD).
nome_gestao_agil_programa	Nome da gestão ágil do programa (texto).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Details

Os filtros são aplicados via o parâmetro filter da função pg_get. Para cada parâmetro informado, é criada uma condição no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Value

Um objeto contendo os dados retornados pela API (geralmente uma lista ou data.frame).

Examples

# Exemplo: consultar programas do ano 2020, modalidade "Ordinário",
  # e com data de início dos planos de ação para beneficiários específicos a partir de "2020-01-01"
  prog <- ler_programas(
    ano_programa = 2020,
    modalidade_programa = "Ordinário",
    data_inicio_recebimento_planos_acao_beneficiarios_especificos = "2020-01-01"
  )
  head(prog)

---

Ler dados de Relatório de Gestão da API TransfereGov

Description

Esta função acessa os dados do endpoint **relatorio_gestao** da API FundoaFundo (TransfereGov) utilizando a função interna pg_get. Os filtros são aplicados por meio do argumento filter e devem estar no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Usage

ler_relatorio_gestao(
  id_relatorio_gestao = NULL,
  data_relatorio_gestao = NULL,
  data_e_hora_relatorio_gestao = NULL,
  tipo_relatorio_gestao = NULL,
  situacao_relatorio_gestao = NULL,
  valor_executado_relatorio_gestao = NULL,
  valor_pendente_relatorio_gestao = NULL,
  resultados_alcancados_metas_relatorio_gestao = NULL,
  descritivo_relatorio_gestao = NULL,
  contrapartida_relatorio_gestao = NULL,
  endereco_eletronico_publicidade_acoes_relatorio_gestao = NULL,
  declaracao_conformidade_relatorio_gestao = NULL,
  id_plano_acao = NULL,
  select = NULL,
  order = NULL
)

Arguments

id_relatorio_gestao	Identificador único do relatório de gestão (numérico).
data_relatorio_gestao	Data do relatório de gestão (formato YYYY-MM-DD).
data_e_hora_relatorio_gestao	Data e hora do relatório de gestão (texto).
tipo_relatorio_gestao	Tipo do relatório de gestão (texto).
situacao_relatorio_gestao	Situação do relatório de gestão (texto).
valor_executado_relatorio_gestao	Valor executado informado no relatório de gestão (numérico).
valor_pendente_relatorio_gestao	Valor pendente informado no relatório de gestão (numérico).
resultados_alcancados_metas_relatorio_gestao	Resultados alcançados em relação às metas (texto).
descritivo_relatorio_gestao	Texto descritivo do relatório de gestão (texto).
contrapartida_relatorio_gestao	Contrapartida informada no relatório de gestão (texto).
endereco_eletronico_publicidade_acoes_relatorio_gestao	Endereço eletrônico de publicidade das ações (texto).
declaracao_conformidade_relatorio_gestao	Declaração de conformidade do relatório de gestão (texto).
id_plano_acao	Identificador do plano de ação associado (numérico).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Value

Um objeto contendo os dados retornados pela API (geralmente um data.frame).

Examples

# Exemplo: ler relatórios de gestão vinculados a um plano de ação
  relatorios <- ler_relatorio_gestao(id_plano_acao = 12345)
  head(relatorios)

---

Ler dados de Ações do Relatório de Gestão da API TransfereGov

Description

Esta função acessa os dados do endpoint **relatorio_gestao_acoes** da API FundoaFundo (TransfereGov) utilizando a função interna pg_get. Os filtros são aplicados por meio do argumento filter e devem estar no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Usage

ler_relatorio_gestao_acoes(
  id_acao_relatorio_gestao = NULL,
  percentual_execucao_fisica_acao_relatorio_gestao_acao = NULL,
  observacoes_justificativas_relatorio_gestao_acao = NULL,
  id_relatorio_gestao = NULL,
  id_acao_meta_plano_acao = NULL,
  select = NULL,
  order = NULL
)

Arguments

id_acao_relatorio_gestao	Identificador único da ação do relatório de gestão (numérico).
percentual_execucao_fisica_acao_relatorio_gestao_acao	Percentual de execução física da ação (numérico).
observacoes_justificativas_relatorio_gestao_acao	Observações e justificativas da ação (texto).
id_relatorio_gestao	Identificador do relatório de gestão associado (numérico).
id_acao_meta_plano_acao	Identificador da ação/meta do plano de ação associado (numérico).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Value

Um objeto contendo os dados retornados pela API (geralmente um data.frame).

Examples

# Exemplo: ler ações vinculadas a um relatório de gestão
  acoes <- ler_relatorio_gestao_acoes(id_relatorio_gestao = 12345)
  head(acoes)

---

Ler dados de Análise do Relatório de Gestão da API TransfereGov

Description

Esta função acessa os dados do endpoint **relatorio_gestao_analise** da API FundoaFundo (TransfereGov) utilizando a função interna pg_get. Os filtros são aplicados por meio do argumento filter e devem estar no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Usage

ler_relatorio_gestao_analise(
  id_relatorio_gestao_analise = NULL,
  tipo_analise_relatorio_gestao_analise = NULL,
  resultado_analise_relatorio_gestao_analise = NULL,
  parecer_analise_relatorio_gestao_analise = NULL,
  origem_analise_relatorio_gestao_analise = NULL,
  data_analise_relatorio_gestao_analise = NULL,
  versao_analise_relatorio_gestao_analise = NULL,
  id_relatorio_gestao = NULL,
  select = NULL,
  order = NULL
)

Arguments

id_relatorio_gestao_analise	Identificador único da análise do relatório de gestão (numérico).
tipo_analise_relatorio_gestao_analise	Tipo da análise do relatório de gestão (texto).
resultado_analise_relatorio_gestao_analise	Resultado da análise do relatório de gestão (texto).
parecer_analise_relatorio_gestao_analise	Parecer da análise do relatório de gestão (texto).
origem_analise_relatorio_gestao_analise	Origem da análise do relatório de gestão (texto).
data_analise_relatorio_gestao_analise	Data da análise do relatório de gestão (formato YYYY-MM-DD).
versao_analise_relatorio_gestao_analise	Versão da análise do relatório de gestão (numérico).
id_relatorio_gestao	Identificador do relatório de gestão associado (numérico).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Value

Um objeto contendo os dados retornados pela API (geralmente um data.frame).

Examples

# Exemplo: ler análises vinculadas a um relatório de gestão
  analises <- ler_relatorio_gestao_analise(id_relatorio_gestao = 12345)
  head(analises)

---

Ler dados de Responsáveis pela Análise do Relatório de Gestão da API TransfereGov

Description

Esta função acessa os dados do endpoint **relatorio_gestao_analise_responsavel** da API FundoaFundo (TransfereGov) utilizando a função interna pg_get. Os filtros são aplicados por meio do argumento filter e devem estar no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Usage

ler_relatorio_gestao_analise_responsavel(
  relatorio_gestao_analise_fk = NULL,
  nome_responsavel_analise_relatorio_gestao_analise = NULL,
  cargo_responsavel_analise_relatorio_gestao_analise = NULL,
  select = NULL,
  order = NULL
)

Arguments

relatorio_gestao_analise_fk	Identificador da análise do relatório de gestão à qual o responsável está vinculado (numérico).
nome_responsavel_analise_relatorio_gestao_analise	Nome do responsável pela análise do relatório de gestão (texto).
cargo_responsavel_analise_relatorio_gestao_analise	Cargo do responsável pela análise do relatório de gestão (texto).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Value

Um objeto contendo os dados retornados pela API (geralmente um data.frame).

Examples

# Exemplo: ler responsáveis vinculados a uma análise
  responsaveis <- ler_relatorio_gestao_analise_responsavel(relatorio_gestao_analise_fk = 12345)
  head(responsaveis)

---

Obter dados do endpoint termo_adesao_historico

Description

Esta função acessa os dados do endpoint **termo_adesao_historico** da API FundoaFundo (TransfereGov) utilizando a função interna pg_get. Em vez de incorporar o endpoint na URL, utiliza-se o parâmetro table = "termo_adesao_historico" para especificar a tabela a ser consultada. Os filtros são aplicados por meio do argumento filter e devem estar no formato "nome_parametro=eq.valor". Todos os parâmetros são opcionais.

Usage

ler_termo_adesao_historico(
  id_historico_termo_adesao = NULL,
  situacao_historico_termo_adesao = NULL,
  data_historico_termo_adesao = NULL,
  id_termo_adesao = NULL,
  select = NULL,
  order = NULL
)

Arguments

id_historico_termo_adesao	Identificador do histórico do termo de adesão (numérico).
situacao_historico_termo_adesao	Situação do histórico do termo de adesão (texto).
data_historico_termo_adesao	Data do histórico do termo de adesão (formato YYYY-MM-DD).
id_termo_adesao	Identificador do termo de adesão ao qual o histórico está vinculado (numérico).
select	Vetor de caracteres com os nomes das colunas a serem retornadas. Quando NULL (padrão), todas as colunas do endpoint são retornadas.
order	Vetor de caracteres com os critérios de ordenação, no formato "coluna.asc" ou "coluna.desc". Quando NULL (padrão), a ordem definida pela API é mantida.

Value

Um objeto contendo os dados retornados pela API (geralmente uma lista ou data.frame).

Examples

# Exemplo: consultar o histórico de um termo de adesão específico
  historico <- ler_termo_adesao_historico(id_termo_adesao = 1234)
  head(historico)

---

Parâmetros aceitos por cada endpoint da API Fundo a Fundo

Description

Lista nomeada que associa o caminho de cada endpoint da API Fundo a Fundo (TransfereGov) ao vetor com os nomes dos parâmetros aceitos por aquele endpoint. Os nomes da lista são os caminhos dos endpoints (por exemplo, "/programa") e cada elemento é um vetor de caracteres.

Usage

metafaftab

Format

A list with 21 elements, each a character vector whose length varies according to the number of parameters of the endpoint.

/programa

vetor com os parâmetros do endpoint de programas

/plano_acao

vetor com os parâmetros do endpoint de planos de ação

/empenho

vetor com os parâmetros do endpoint de empenhos

...

demais endpoints da API

Details

Metadados dos endpoints da API Fundo a Fundo

A lista é obtida a partir da especificação OpenAPI publicada pela própria API. Ela serve de referência para descobrir os nomes válidos dos parâmetros de filtro aceitos por cada função ler_*/get_* do pacote.

Source

Especificação OpenAPI da API Fundo a Fundo, em https://api.transferegov.gestao.gov.br/fundoafundo/ (o servidor responde apenas a requisições GET).

References

Documentação do TransfereGov: https://www.gov.br/transferegov/pt-br

Examples

names(metafaftab)
metafaftab[["/programa"]]

---

IBGE e SIAFI Lista de IDs

Description

Tabela de correspondência entre os códigos de município utilizados pelo SIAFI e os códigos de município do IBGE, com o nome do município, a unidade da federação e o CNPJ da prefeitura. Os dados são extraídos do arquivo tabmun.csv publicado pelo Tesouro Transparente.

Usage

municipios_siafi_ibge

Format

A data frame with 5589 observations on the following 5 variables.

codigo_municipio_siafi

a character vector with 4 digit SIAFI code

cnpj

a character vector of business fiscal CNPJ code

nome_municipio

a character vector with city name

uf

a character vector of UF 2 char abbreviation

codigo_ibge

a numeric vector with City's IBGE Code

Details

Mapeamento entre códigos de município SIAFI e IBGE

O código SIAFI é mantido como texto para preservar os zeros à esquerda, que são significativos. As junções entre os dados do Portal da Transparência e este mapeamento devem sempre ser feitas pela coluna codigo_municipio_siafi, e não pela coluna cnpj.

Source

Tesouro Transparente, arquivo tabmun.csv: https://www.tesourotransparente.gov.br/

References

Portal da Transparência do Governo Federal: https://portaldatransparencia.gov.br/

Examples

str(municipios_siafi_ibge)
head(municipios_siafi_ibge)

---