getManifest: Obtain metadata information from an HCAExplorer object

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

Description

Obtain metadata infromation from an HCAExplorer object. This metadata can then be passed on to download files from other services.

Usage

## S4 method for signature 'HCAExplorer'
getManifest(x, fileFormat)

Arguments

x	An HCAExplorer object
fileFormat	character. A character vector of file formats of metadata to obtain. The possible aruments can be found using the getManifestFileFormats method.

Value

a tibble of metadata information.

See Also

HCAExplorer for the HCAExplorer class, getManifestFileFormats for how to obtain file formats that can be used as arguments in this function.

Examples

 ## Initiate an HCAExplorer object.
 x <- HCAExplorer()
 ## View the HCAExplorer object to decide which projects to subset.
 x

 ## Decide to subset first project.
 x <- x[1,]
 x

 ## Get all possible manifest file formats for the project.
 formats <- getManifestFileFormats(x)
 formats

 ## Obtain the manifest for the file using only the first format
 manifest <- getManifest(x, formats[1])
 manifest

Bioconductor/HCAExplorer documentation built on Feb. 13, 2021, 7:07 a.m.