searchForEvents: Function to search for events that fulfill pre-specified...

Description Usage Arguments Value Author(s) Examples

View source: R/searchForEvents.R

Description

Function to search for events that fulfill pre-specified search conditions over the Search API

Usage

1
2
3
4
5
6
7
8
9
searchForEvents(
  search_conditions,
  order_by = "identifier",
  sort_by = "asc",
  result_limit = NA,
  uuids_only = F,
  precise = T,
  iteration = 1000L
)

Arguments

search_conditions

the search condition data.frame that the funding_rounds have to fulfill

order_by

(Optional) field by which to sort the results

sort_by

(Optional) sort direction to sort the order field by. Either 'asc' or 'desc'.

result_limit

(Optional) numeric limit of the number of results you'd like to have. By default, all results will be returned to you.

uuids_only

(Optional) Logical if you want to have only the uuids of the searched for entities returned. By default, after the uuids are retrieved, the information for all entities will be looked up over the entity lookup API endpoint, which takes longer.

precise

(Optional) Logical Default to TRUE. For a large number of results, you may want to set precise to FALSE as realtime updates may make the function otherwise run on indefinitely. When you set precise to FALSE, the last iteration set of results will not be returned. You can modify this parameter with the argument iteration.

iteration

(Optional) numeric iteration step. Default to 1000L, max 2000L. The last iteration will be discarded if you set precise to FALSE. Otherwise, this parameter won't affect you.

Value

a data.frame

Author(s)

Layla Rohkohl, byehity@gmail.com

Examples

1
searchForEvents(rbind(searchCondition1,searchCondition2))

Lyrohk/cruncher documentation built on Dec. 17, 2021, 1:17 a.m.