ldsearch: Search Notices

Description Usage Arguments Details Value Examples

View source: R/http.R

Description

Search for Lumen Database Notices

Usage

1
ldsearch(query = list(), page = 1, per_page = 10, verbose = TRUE, ...)

Arguments

query

A list specifying search query parameters. A reasonable default query would be query = list(term = "joe") to search for entities containing the word “joe”. See API Documentation for details of search query terms.

page

A numeric value specifying which page of results to return. Pagination details are stored in the meta attribute of the response object.

per_page

A numeric value specifying the number of entities to return in one page. Pagination details are stored in the meta attribute of the response object.

verbose

A logical (TRUE, by default) specifying whether to print pagination details to the console.

...

Additional arguments passed to lumenHTTP.

Details

This function retrieves a list of notices matching a query. Results are paginated by the page and per_page arguments. Individual notices can instead be retrieved by their ID using ldnotice.

Value

A list of objects of class “lumen_notice”. The default print method will display some essential details of each topic.

Examples

1
2
3
4
5
6
## Not run: 
# find YouTube-related notices
x <- ldsearch(query = list(term = "youtube"))
str(x, 1)

## End(Not run)

leeper/lumen documentation built on Oct. 14, 2017, 7:08 a.m.