setCachedCommonInfo: Set and get cached commons

In iSEE: Interactive SummarizedExperiment Explorer

Description

Get and set common cached information for each class. The setter should only ever be called in .cacheCommonInfo. The getter can be called anywhere but most usually in .defineInterface.

Usage

.setCachedCommonInfo(se, cls, ...)

.getCachedCommonInfo(se, cls)

Arguments

se	A SummarizedExperiment object containing the current dataset.
cls	String containing the name of the class for which this information is cached.
...	Any number of named R objects to cache.

Value

.setCachedCommonInfo returns se with ... added to its int_metadata.

.getCachedCommonInfo retrieves the cached common information for class cls.

Author(s)

Aaron Lun

See Also

?"cache-utils", for utilities to define some cached variables.

Examples

se <- SummarizedExperiment()
se <- .setCachedCommonInfo(se, "SomePanelClass",
    something=1, more_things=TRUE, something_else="A")
.getCachedCommonInfo(se, "SomePanelClass")

iSEE documentation built on Feb. 3, 2021, 2:01 a.m.