Usage

Arguments

query

string: the search term

fq

string: (optional) character string or vector
of strings, specifying filters to be applied to the
original query. These are of the form
"INDEXEDFIELD:VALUE" e.g. "kingdom:Fungi". See
ala_fields("general") for all the fields that are
queryable. NOTE that fq matches are case-sensitive, but
sometimes the entries in the fields are not consistent in
terms of case (e.g. kingdom names "Fungi" and "Plantae"
but "ANIMALIA"). fq matches are ANDed by default (e.g.
c("field1:abc","field2:def") will match records that have
field1 value "abc" and field2 value "def"). To obtain OR
behaviour, use the form c("field1:abc OR field2:def")

output_format

string: controls the print method
for the "data" component of the returned object. Either
"complete" (the complete data structure is displayed), or
"simple" (a simplified version is displayed). Note that
the complete data structure exists in both cases: this
option only controls what is displayed when the object is
printed to the console. The default output format is
"simple"

start

numeric: (optional) (positive integer) start
offset for the results

page_size

numeric: (optional) (positive integer)
maximum number of records to return. Defaults to the
server-side value - currently 10

sort_by

string: (optional) field to sort on

sort_dir

string: (optional) sort direction, either
"asc" or "desc"

Value

a named list with the components "meta" (search metadata),
"facets" (search facet results), and "data" (the search
results, in the form of a dataframe). The contents (column
names) of the data frame will vary depending on the details
of the search and the results, but should contain at least
the columns guid, name, score,
commonName, rank, author,
isAustralian, and occurrenceCount.