tbl_hca: 'tibble' representation of HCA query results

hca_next.tbl_hcaR Documentation

'tibble' representation of HCA query results

Description

projects(), samples(), files(), and bundles() return, by default, a 'tibble' representation of the query.

hca_next() returns the next 'page' of results, if available.

hca_prev() returns the previous 'page' of results.

Usage

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

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

Arguments

x

a 'tibble' 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 tibble, with the same columns as x, containing the next 'page' of results.

hca_prev() returns a tibble with the same columns as x, containing the previous 'page' of results.

Examples

projects <- projects(size = 5)      # 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.