Skip to contents

Obter dados do endpoint /programa

Source: R/ler_programas.R
ler_programas.Rd

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.

Value

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

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.

Examples

# \donttest{
  # 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)
#> data frame with 0 columns and 0 rows
# }