WorldHealthOrganization / finderquery

Utilities for building Finder queries in a simple and intuitive way, including an API that and web application that provides an interface for building a query and downloading documents.

finderquery

The finderquery package provides utilities for building Finder queries in a simple and intuitive way. It also provides an API that uses these utilities as well as code for a web application that provides an interface for building a query and downloading documents.

Note that this package is not of general use to the public. It is built to work against the Finder system used by EIOS. It is only made public to make it easier to share with EIOS, as there is nothing proprietary stored in this repository.

Installation

You can install the package from Github with:

# install.packages("remotes")
remotes::install_github("hafen/finderquery")

Examples

See the full "usage" documentation for many more examples as well as details on how everything works.

library(finderquery)

# specify Finder location
con <- finder_connect("10.49.4.6")

# query all documents in German that have category "CoronavirusInfection" 
# that were published in the last two days, sorted by publication date
res <- query_fetch(con) %>%
  filter_language("de") %>%
  filter_category("CoronavirusInfection") %>%
  filter_pubdate(from = as.Date(Sys.time()) - 2) %>%
  run()

# count documents by top 10 categories over the last 2 days
res <- query_facet(con) %>%
  filter_pubdate(from = as.Date(Sys.time()) - 2) %>%
  facet_by("category", limit = 10) %>%
  run()

# count documents daily for all "CoronavirusInfection" articles over
# the last 20 days, hourly
res <- query_facet(con) %>%
  filter_category("coronavirusinfection") %>%
  facet_date_range(
    start = as.Date(Sys.time()) - 20,
    end = as.Date(Sys.time()),
    gap = range_gap(1, "HOUR")
  ) %>%
  run()