listPaths: List all paths for a dataset

In LTLA/scRNAseq: Collection of Public Single-Cell RNA-Seq Datasets

List all paths for a dataset

Description

List the available paths to subdatasets within a version of a given dataset.

Usage

listPaths(
  name,
  version,
  package = "scRNAseq",
  cache = cacheDirectory(),
  overwrite = FALSE,
  include.metadata = FALSE
)

Arguments

name	String containing the name of the dataset.
version	String containing the version of the dataset.
package	String containing the name of the package.
cache, overwrite	Arguments to pass to saveVersion or saveFile.
include.metadata	Logical scalar indicating whether to report the metadata for each subdataset.

Value

If include.metadata=FALSE, a character vector containing the paths to subdatasets within the specified version of the dataset. If name does not contain any subdatasets, NA is returned.

Otherwise, a DFrame is returned containing the metadata for each subdataset, e.g., the title and description. More details can be found in the Bioconductor metadata schema at https://github.com/ArtifactDB/bioconductor-metadata-index.

Author(s)

Aaron Lun

Examples

listPaths("he-organs-2020", "2023-12-21")
listPaths("he-organs-2020", "2023-12-21", include.metadata=TRUE)
listPaths("zeisel-brain-2015", "2023-12-14") # no subdatasets
listPaths("zeisel-brain-2015", "2023-12-14", include.metadata=TRUE) 

LTLA/scRNAseq documentation built on Jan. 22, 2025, 7:43 p.m.