collect()
attempts to retrieve the result of a query from the
selected API.
Usage
# S3 method for data_request
collect(x, ..., wait = TRUE, file = NULL)
# S3 method for metadata_request
collect(x, ...)
# S3 method for files_request
collect(x, ...)
# S3 method for query
collect(x, ..., wait = TRUE, file = NULL)
# S3 method for computed_query
collect(x, ..., wait = TRUE, file = NULL)
Arguments
- x
An object of class
data_request
,metadata_request
orfiles_request
(fromgalah_call()
); or an object of classquery_set
orquery
(fromcollapse()
orcompute()
)- ...
Arguments passed on to other methods
- wait
logical; should
galah
wait for a response? Defaults to FALSE. Only applies fortype = "occurrences"
or"species"
.- file
(Optional) file name. If not given, will be set to
data
with date and time added. The file path (directory) is always given bygalah_config()$package$directory
.
Value
In most cases, collect()
returns a tibble
containing requested
data. Where the requested data are not yet ready (i.e. for occurrences when
wait
is set to FALSE
), this function returns an object of class query
that can be used to recheck the download at a later time.