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.

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

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

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.

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
)

Arguments

Value

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

Examples

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

## End(Not run)

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
)

Arguments

Value

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

Examples

## Not run: 
  # 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)

## End(Not run)

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
)

Arguments

Value

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

Examples

## Not run: 
  # 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)

## End(Not run)

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
)

Arguments

Value

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

Examples

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

## End(Not run)

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
)

Arguments

Value

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

Examples

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

## End(Not run)

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
)

Arguments

Value

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

Examples

## Not run: 
  # 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)

## End(Not run)

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
)

Arguments

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
)

Arguments

Value

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

Examples

## Not run: 
  # 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)

## End(Not run)

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
)

Arguments

Value

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

Examples

## Not run: 
  # 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)

## End(Not run)

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
)

Arguments

Value

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

Examples

## Not run: 
  # 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)

## End(Not run)

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
)

Arguments

Value

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

Examples

## Not run: 
  # 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)

## End(Not run)

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
)

Arguments

Value

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

Examples

## Not run: 
  # 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)

## End(Not run)

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
)

Arguments

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

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

## End(Not run)

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
)

Arguments

Value

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

Examples

## Not run: 
  # 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)

## End(Not run)

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
)

Arguments

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

## Not run: 
  # 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)

## End(Not run)

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
)

Arguments

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
)

Arguments

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

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

## End(Not run)

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
)

Arguments

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

## Not run: 
  # 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)

## End(Not run)

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
)

Arguments

Value

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

Examples

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

## End(Not run)

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
)

Arguments

Value

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

Examples

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

## End(Not run)

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
)

Arguments

Value

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

Examples

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

## End(Not run)

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
)

Arguments

Value

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

Examples

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

## End(Not run)

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
)

Arguments

Value

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

Examples

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

## End(Not run)

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)