Base function to query the iDigBio API
Usage
idig_search(
type = "records",
mq = FALSE,
rq = FALSE,
fields = FALSE,
max_items = 1e+05,
limit = 0,
offset = 0,
sort = FALSE,
...
)Arguments
- type
string type of records to query, defaults to "records"
- mq
iDigBio media query in nested list format
- rq
iDigBio record query in nested list format
- fields
vector of fields that will be contained in the data.frame
- max_items
CURRENTLY IGNORED, SEE ISSUE #33 maximum number of results allowed to be retrieved (fail-safe)
- limit
maximum number of results returned
- offset
number of results to skip before returning results
- sort
vector of fields to use for sorting, UUID is always appended to make paging safe
- ...
additional parameters
Details
This function is wrapped for media and specimen record searches. Please
consider using idig_search_media or
idig_search_records instead as they supply nice defaults to
this function depending on the type of records desired.
Fuller documentation of parameters is in the
idig_search_records function's help.
Exported to facilitate wrapping this package in other packages.
Examples
if (FALSE) { # \dontrun{
# Ten media records related to genus Acer specimens
idig_search(type="media", rq=list(genus="acer"), limit=10)
} # }