Description Usage Arguments Value Author(s) References See Also Examples
View source: R/search_fulltext.R
Performs a search across all objects, and selects the
closest matches. Generally, the user will provide the
search term via the query
parameter, with optional
filtering via fq
.
1 2 | search_fulltext(query, fq, output_format = "simple", start, page_size,
sort_by, sort_dir)
|
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
|
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" |
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
.
Atlas of Living Australia support@ala.org.au
1 2 3 4 5 6 7 | # find information ALA holds on red kangaroo
search_fulltext("red kangaroo")
search_fulltext("Macropus rufus")
search_fulltext("urn:lsid:biodiversity.org.au:afd.taxon:31a9b8b8-4e8f-4343-a15f-2ed24e0bf1ae")
# find genus names like "Oenanthe"
search_fulltext("oenanthe",sort_by="kingdom",fq="rank:genus")
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.