list_hca: 'list' representation of HCA query results

hca_next.list_hcaR Documentation

'list' representation of HCA query results

Description

projects(), samples(), files() and bundles() return results for the number of records indicated by the size= argument. Use as = "list" to return results as a "list_hca" list.

hca_next() returns a list containing the next 'page' of results.

hca_prev() returns a list containing the previous 'page' of results.

Usage

## S3 method for class 'list_hca'
hca_next(x, size)

## S3 method for class 'list_hca'
hca_prev(x, size)

Arguments

x

a 'list' returned by projects(), samples(), files(), or bundles().

size

the (non-negative integer) number of elements to retrieve in the page request. The default is the number of elements requested in x.

Value

hca_next() returns a list containing the next 'page' of results.

hca_prev() returns a list containing the previous 'page' of results.

Examples

projects <- projects(size = 5, as = "list") # projects 1-5
next_projects <- hca_next(projects)         # projects 6-10

hca_prev(next_projects)            # projects 1-5


Bioconductor/hca documentation built on July 28, 2022, 6:04 p.m.