bhl_namemetadata: Get basic title, item, and page metadata for each page on...

Description Usage Arguments Examples

View source: R/bhl_namegetdetail.R

Description

Get basic title, item, and page metadata for each page on which the specified name appears.

Usage

1
2
3
4
5
6
7
8
bhl_namemetadata(
  namebankid = NULL,
  name = NULL,
  id_type = NULL,
  as = "list",
  key = NULL,
  ...
)

Arguments

namebankid

(numeric) (not used if 'name' specified) NameBank identifier for a name

name

(character) (not used if 'namebankid' specified) a complete name string

id_type

(character) the type of identifier (namebank, eol, gni, ion, col, gbif, itis, ipni, worms). Not used if name is specified

as

(character) Return a list ("list"), json ("json"), xml ("xml"), or parsed table ("table", default). Note that as="table" can give different data format back depending on the function - for example, sometimes a data.frame and sometimes a character vector.

key

Your BHL API key, either enter, or loads from your .Renviron as BHL_KEY or from .Rprofile as bhl_key.

...

Curl options passed on to crul::HttpClient()

Examples

1
2
3
4
5
6
## Not run: 
res <- bhl_namemetadata(name = 'poa annua linnaeus')
str(res)
# bhl_namemetadata(namebankid = 3501464)

## End(Not run)

rbhl documentation built on May 13, 2021, 9:07 a.m.