ldentities: Get Entities
In lumendb: Lumen Database API Client

Description Usage Arguments Details Value Examples

View source: R/http.R

Get a list of Lumen Database entities matching a query

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

`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”.
`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`.

This function retrieves a list of “entities” named in the Lumen Database that match a query. See API Documentation for details. Results are paginated by the page and per_page arguments.

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

## Not run: 
# return entities matching "joe"
ldentities(query = list(term = "joe"))

# use non-default pagination arguments
ldentities(query = list(term = "pub"), page = 3, per_page = 5)

## End(Not run)