SearchResult: Results from searching the HCA

In Bioconductor/HCABrowser: Browse the Human Cell Atlas data portal

Description

A 'SearchResult' is returned by 'searchBundles()', and represents the results for the search. Use 'results()' to view current results, and 'nextResults()' to page through results.

Usage

nextResults(x)

results(x)

## S3 method for class 'SearchResult'
as_tibble(x, ...)

## S4 method for signature 'SearchResult'
show(object)

Arguments

x	A SearchResult returned by 'searchBundles()'.
...	additional parameters (unused)
object	a SearchResult object.

Value

'nextResults()' returns a 'SearchResult' representing the next 'page' of results from the original query.

'results()' returns a list-of-lists, with each element representing a distinct results of the HCABrowser query.

The 'as_tibble' method for 'SearchResult' returns a tibble representing the search result, with each row corresponding to a distinct result.

Examples

bundles <- searchBundles(HCABrowser())  # Find all bundles...
bundles                                 # ... but retrieve first 100

nextResults(bundles)                    # ... and then next 100

bundles %>%
    ## results() returns a list-of-lists
    results() %>%
    ## this is the structure of the first result
    head(1) %>%
    str()

bundles %>% as_tibble()

Bioconductor/HCABrowser documentation built on Feb. 10, 2021, 12:51 p.m.