searchDatasets: Search dataset metadata

View source: R/searchDatasets.R

searchDatasetsR Documentation

Search dataset metadata

Description

Search for datasets of interest based on matching text in the associated metadata.

Usage

searchDatasets(
  query,
  cache = cacheDirectory(),
  overwrite = FALSE,
  latest = TRUE
)

Arguments

query

String containing a query in a human-readable syntax or a gypsum.search.clause, see Examples.

cache, overwrite

Arguments to pass to fetchMetadataDatabase.

latest

Whether to only consider the latest version of each dataset.

Details

The returned DataFrame contains the usual suspects like the title and description for each dataset, the number of rows and columns, the organisms and genome builds involved, whether the dataset has any pre-computed reduced dimensions, and so on. More details can be found in the Bioconductor metadata schema at https://github.com/ArtifactDB/bioconductor-metadata-index.

Value

A DataFrame where each row corresponds to a dataset, containing various columns of metadata. Some columns may be lists to capture 1:many mappings.

Author(s)

Aaron Lun

See Also

surveyDatasets, to easily obtain a listing of all available datasets.

translateTextQuery, for details on the human-readable query syntax.

Examples

searchDatasets("brain")[,c("name", "title")]
searchDatasets("Neuro%")[,c("name", "title")]
searchDatasets("taxonomy_id:10090")[,c("name", "title")]
searchDatasets("(genome: GRCm38 AND neuro%) OR pancrea%")[,c("name", "title")]


LTLA/scRNAseq documentation built on June 28, 2024, 7:31 p.m.