cp_ds: Datasets API route catch all method

In ropensci/rcol: Catalogue of Life Client

Datasets API route catch all method

Description

Datasets API route catch all method

Usage

cp_ds(route, ..., .list = list())

Arguments

route	(character) an API route. the /dataset route part is added internally; so just include the route following that. required.
...	named parameters, passed on to glue::glue(). required. param names must match must match names given in the route. For example, if you have route = \\{key\\}/name\\{id\\}, then you need to pass in a key and an id parameter. The names in the route (here, key and id) don't have to match the names in the API route you are trying to use - they just need to match the named parameters you pass in. Having said that, it may be easier to remember what you're doing if you match the names to the route parts.
.list	a named list. instead of passing in named parameters through ..., you can pre-prepare a named list and give to this parameter

Details

There are A LOT of datasets API routes. Instead of making an R function for each route, we have R functions for some of the "more important" routes, then cp_ds() will allow you to make requests to the remainder of the datasets API routes.

Value

output varies depending on the route requested, but output will always be a named list. when no results found, an error message will be returned

Not supported dataset routes

Some dataset routes do not return JSON so we don't support those. Thus far, the only route we don't support is /dataset/\\{key\\}/logo

Examples

## Not run: 
cp_ds(route = "{key}/tree", key = "1000")
cp_ds(route = "{key}/tree", key = "1014")
cp_ds(route = "{key}/name/{id}", key = 1005, id = 100003)

# pass a named list to the .list parameter
args <- list(key = 1005, id = 100003)
cp_ds("{key}/name/{id}", .list = args)

## End(Not run)

ropensci/rcol documentation built on Sept. 12, 2022, 8:08 a.m.