bhl_gettitlemetadata: Get title metadata

Description Usage Arguments Examples

View source: R/bhl_gettitlemetadata.R

Description

Return metadata about a title. You may choose to include a list of the items (books) associated with the title.

Usage

1
bhl_gettitlemetadata(titleid = NA, items = FALSE, as = "list", key = NULL, ...)

Arguments

titleid

the identifier of an individual title (numeric)

items

(logical) TRUE of FALSE (default) to inclue items

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: 
bhl_gettitlemetadata(1726, items = TRUE)
bhl_gettitlemetadata(1726, as='list')
bhl_gettitlemetadata(1726, as='xml')

## End(Not run)

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