knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

Querido Diário API Wrapper

Visão Geral

Esse pacote faz parte de um projeto chamado Querido Diário da Open Knowledge Brasil. A iniciativa tem como objetivo libertar e centralizar as informações nos diários oficiais dos municípios, hoje presas em PDFs obscuros de acesso complicado.

O Querido Diário fornece uma maneira simples de acessar à API e fazer consultas a ela. Diariamente estamos coletando os diários e processando seu conteúdo para obter todo o texto desses diários.

No pacote está disponível uma base contendo as informaçoes sobre os municípios e seus respectivos IDs.

Este é o Wrapper em Python: querido-diario-api-wrapper.

Instalação

Para instalar a partir do endereço de um dos repositórios você precisa ter o pacote {remotes} instalado

# Para instalar pacote remotes
install.packages("devtools")
# Para instalar a versão GitHub (dev)
devtools::install_github("katerine-dev/queridodiario")

Exemplo

Algumas buscas que são possíveis de se fazer nesse momento: - Obter os Diários Oficiais de um município dentro de um período determinado de tempo e retornar o link para seus arquivos PDFs. Por exemplo, podemos buscar todos os Diários Oficiais de Natal-RN no período de 01/01/2012 até 31/01/2021; - Obter todos os Diários Oficiais que contenham determinadas palavras-chave. Por exemplo podemos buscar todos os Diários Oficiais de Natal-RN que contenham as palavras "COVID" e "hidroxicloroquina" em toda história ou em determinado período de tempo.

A busca por palavra-chave ainda é limitada e ainda não conseguimos isolar partes dos Diários. Então a busca por palavras muito genéricas pode retornar uma quantidade de resultados muito grande. Por exemplo, se procurarmos por "prefeito", é bem provável que todos os Diários contenham essa palavra.

O pacote pode ser carregado usando:

library(queridodiario) # Carrega o pacote
# para visualizar a base 
dplyr::glimpse(territories)

Contendo:

knitr::kable(territories)

Usando a função

# Retorna os diários entre  01/01/2020 e 31/01/2021 que contém as palavras 
# 'covid' e 'cloroquina' no território '2408102' (Manaus-AM)

get_gazettes(
  since = "2020-01-01",
  until = "2021-01-31",
  keywords = "covid",
  territory_id = "1302603",
  offset = 0,
  size = 1
)

Requisitos

{queridodiario} requer uma versão do R superior ou igual a 2.10.

Licença

O {queridodiario} é licenciado sob os termos MIT.



katerine-dev/queridodiario documentation built on Dec. 21, 2021, 5:20 a.m.