compute_galah: Compute a query

compute_galahR Documentation

Compute a query

Description

compute() is useful for several purposes. It's original purpose is to send a request for data, which can then be processed by the server and retrieved at a later time (via collect()). However, because query-altering functions (such as filter() and select()) are evaluated lazily from galah version 2.0 onwards, compute() is also the function where all objects within the query_set are evaluated, and any checks run using that information. Therefore it is possible for invalid queries to be built using collapse(), but fail at compute().

Usage

## S3 method for class 'data_request'
compute(x, ...)

## S3 method for class 'metadata_request'
compute(x, ...)

## S3 method for class 'files_request'
compute(x, ...)

## S3 method for class 'query_set'
compute(x, ...)

## S3 method for class 'query'
compute(x, ...)

Arguments

x

An object of class data_request, metadata_request or files_request (i.e. constructed using a pipe) or query or query_set (i.e. constructed by collapse())

...

Arguments passed on to other methods

Value

An object of class query containing a checked, valid query for the selected atlas. In the case of occurrence data, also contains information on the status of the request.


galah documentation built on Nov. 20, 2023, 9:07 a.m.