Skip to contents

Unlike brapi_lists(), which returns only list metadata, this returns a single list together with its members in the data list-column. listType says what the members are (for example "germplasm").

Usage

brapi_list(con, listDbId)

Arguments

con

A brapi_connection() object.

listDbId

Character. The unique list identifier.

Value

A single-row tibble of list metadata, with the list's members as a character vector in the data list-column.

BrAPI endpoint

GET /lists/{listDbId} - see the v2.1 specification.

Examples

# \donttest{
con <- brapi_connection("https://test-server.brapi.org")
lst <- brapi_list(con, "list1")
lst$data[[1]]
#> [1] "germ1" "germ2" "germ3"
# }