utilities {ExperimentHub}R Documentation

Utility functions for discovering package-specific Hub resources.

Description

List and load resources from ExperimentHub filtered by package name and optional search terms.

Usage

listResources(hub, package, filterBy = character())
loadResources(hub, package, filterBy = character())

Arguments

hub

A Hub object; currently only meaningful for ExperimentHub.

package

A character(1) name of a package with resources hosted in the Hub.

filterBy

A character() vector of search terms for additional filtering. Can be any terms found in the metadata (mcols()) of the resources. When not provided, there is no additional filtering and all resources associated with the given package are returned.

Details

Currently listResources and loadResources are only meaningful for ExperimentHub objects.

Value

listResources returns a character vector; loadResources returns a list of data objects.

Examples

## Not run: 
## Packages with resources hosted in ExperimentHub:
require(ExperimentHub)
eh <- ExperimentHub()
unique(package(eh))

## All resources associated with the 'GSE62944' package:
listResources(eh, "GSE62944")

## Resources associated with the 'curatedMetagenomicData' package
## filtered by 'plaque.abundance':
listResources(eh, "curatedMetagenomicData", "plaque.abundance")

## 'loadResources()' returns a list of the data objects:
loadResources(eh, "curatedMetagenomicData", "plaque.abundance")

## End(Not run)
[Package ExperimentHub version 1.14.2 Index]