get_records {ArctosR} | R Documentation |
Get records from Arctos based on a query
Description
Make a request to Arctos to return data based on a query. The columns
(fields) returned are specified in the list defined in columns
.
A list of possible query keys can be obtained from the output of
get_query_parameters
.
Usage
get_records(..., api_key = NULL, columns = NULL, limit = NULL,
filter_by = NULL, all_records = FALSE)
Arguments
... |
Query parameters and their values to pass to Arctos to search.
For example, |
api_key |
(character) The API key to use for this request.
The default, |
columns |
A list of columns to be returned in the table of records to be downloaded from Arctos. |
limit |
(numeric) The maximum number of records to download at once. Default is 100. |
filter_by |
An optional list of record attributes to filter results by. |
all_records |
(logical) If true, the request is performed multiple times to obtain data from Arctos until all records matching the query have been downloaded. |
Value
A query object consisting of metadata for each request sent to Arctos to fulfill the user's query, and a data frame of records.
Examples
library(ArctosR)
# Request to download all available data
query <- get_records(
scientific_name = "Canis lupus", guid_prefix = "MSB:Mamm",
columns = list("guid", "parts", "partdetail")
)