get_eol_page: Get Encyclopedia of Life (EOL) Page

View source: R/eol.R

get_eol_pageR Documentation

Get Encyclopedia of Life (EOL) Page

Description

Alterations to default parameter values: common_names (FALSE => TRUE), synonyms: (FALSE => TRUE).

Usage

get_eol_page(id, batch = FALSE, images_per_page, images_page = 1,
  videos_per_page, videos_page = 1, sounds_per_page, sounds_page = 1,
  maps_per_page, maps_page = 1, texts_per_page, texts_page = 1,
  subjects = "overview", licenses = "all", details = FALSE,
  common_names = TRUE, synonyms = TRUE, references = FALSE,
  taxonomy = TRUE, vetted = 0, cache_ttl, language = "en")

Arguments

id

(character) EOL Page ID.

batch

(boolean) Whether to return a batch.

images_per_page

(integer) Max image objects to return.

images_page

(integer) Image page number.

videos_per_page

(integer) Max video object to return.

videos_page

(integer) Video page number.

sounds_per_page

(integer) Max sound objects to return.

sounds_page

(integer) Sound page number.

maps_per_page

(integer) Max map objects to return.

maps_page

(integer) Map page number.

texts_per_page

(integer) Max text objects to return.

texts_page

(integer) Text page number.

subjects

(character) Result type: "overview" or "all".

licenses

(character) Pipe-delimited list of licenses: "all" or "cc-by", "cc-by-nc", "cc-by-sa", "cc-by-nc-sa", "pd" (public domain), or "na" (not applicable).

details

(boolean) Whether to return all metadata for data objects.

common_names

(boolean) Whether to return all common names.

synonyms

(boolean) Whether to return all scientific synonyms.

references

(boolean) Whether to return all references.

taxonomy

(boolean) Whether to return taxonomy details from taxon hierarchy providers.

vetted

(integer) Trusted content filter level: 0 (all content), 1 (trusted content), 2 (trusted and unreviewed content), 3 (unreviewed content), or 4 (only untrusted content).

cache_ttl

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

language

(character) Response language: "en" or ms, de, es, fr, gl, it, nl, nb, oc, pt-BR, sv, tl, mk, sr, uk, ar, zh-Hans, zh-Hant, or ko.

Source

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

See Also

Other EOL functions: get_eol_search, parse_eol_page, parse_eol_search

Examples

s <- get_eol_search("Malus domestica")
id <- parse_eol_search(s, "ids")$ids[1]
str(httr::content(get_eol_page(id)))

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