get_eol_search: Get Encyclopedia of Life (EOL) Search Results

View source: R/eol.R

get_eol_searchR Documentation

Description

Alterations to default parameter values: exact (FALSE => TRUE). For reliable results, run an exact search (exact = TRUE) with a scientific name search string (q).

Usage

get_eol_search(q, page = 1, exact = TRUE, filter_by_taxon_concept_id,
  filter_by_hierarchy_entry_id, filter_by_string, cache_ttl)

Arguments

q

(character) Search string.

page

(integer) Index of result page to return (each of which includes up to 30 results).

exact

(boolean) Whether to only return taxons whose title, synonym or common name exactly matches q.

filter_by_taxon_concept_id

(integer) EOL Page ID. Results will be limited to members of that taxonomic group.

filter_by_hierarchy_entry_id

(integer) Hierarchy Entry ID. Results will be limited to members of that taxonomic group.

filter_by_string

(character) Results will be limited to members of the taxonomic group matching the search term.

cache_ttl

(integer) Seconds you wish to have the response cached.

Source

http://eol.org/api/docs/search

See Also

Other EOL functions: get_eol_page, parse_eol_page, parse_eol_search

Examples

str(httr::content(get_eol_search("Malus domestica"))) # few equivalent results

falling-fruit/fruitr documentation built on Dec. 21, 2024, 8:32 p.m.