query-helpers: Helper functions for constructing the queries

In hansel-oy/hilma: An R package for accessing the Hilma API

Description

Functions for constructing the query_params-argument of the fetch_notices()-function. Functions suffixed with _filter and _search use the respective functionalities of the Azure Cognitive Search.

Usage

query_and(q1, q2)

query_or(q1, q2)

dps_filter(is_dps = TRUE)

framework_agreement_filter(is_fa = TRUE)

is_national_filter(is_national = TRUE)

notice_number_filter(notice_number)

id_filter(id)

procurement_project_filter(id)

all_notices_modified_since_filter(since = today() %m-% days(1))

all_notices_modified_until_filter(until = today())

all_notices_published_since_filter(since = today() %m-% days(1))

all_notices_published_until_filter(until = today())

organisation_name_search(name)

organisation_id_search(organisation_id)

cpv_search(cpv)

Arguments

q1	First query
q2	Second query
is_dps	Whether to filter notices that are for DPSs or notices that are not for DPSs.
is_fa	Whether to filter notices that are for FAs or notices that are not for FAs.
is_national	Whether to filter notices that are for FAs or notices that are not for FAs.
notice_number	The notice number. E.g. "2020-000001".
id	The id of the procurement project. E.g. 1L.
since	A date-object. Includes the boundary and defaults to yesterday.
until	A date-object. Includes the boundary and defaults to today.
name	The name of the procuring organisation. E.g. "Hansel Oy".
organisation_id	The national registration id of the procuring organisation. E.g. "1234567-8".
cpv	The cpv code to search E.g. "00000000".

Details

query_and and _or can be used to combine queries (see example below).

Value

A list containing the query that can be passed to fetch_notices().

Examples

# A query that returns all notices modified 2020-01-01 or later
# from a certain organisation
q <- organisation_id_filter("1234567-8") %>%
query_and(all_notices_modified_since_filter(lubridate::ymd("2020-01-01")))
fetch_notices(q, api_key)

hansel-oy/hilma documentation built on Feb. 20, 2020, 3:20 a.m.