isCurrent: Use version information to test whether class is current

Description

This generic function uses Versioned-class information to ask whether an instance of a class (e.g., read from disk) has current version information.

By default, isCurrent has the following behaviors:

isCurrent(Versioned-instance): Returns a vector of logicals, indicating whether each version matches the current version from the class prototype.

isCurrent(ANY)

Return NA, indicating that the version cannot be determined

isCurrent(Versioned-instance, "class")

Returns a logical vector indicating whether version identifiers shared between Versioned-instance and "class" are current.

Starting with R-2.6 / Bioconductor 2.1 / Biobase 1.15.1, isCurrent(Versioned-instance, ...) returns an element S4 indicating whether the class has the `S4' bit set; a value of FALSE indicates that the object needs to be recreated.

Usage

isCurrent(object, value)

Arguments

object

Object whose version is to be determined, as described above.

value

(Optional) character string identifying a class with which to compare versions.

Value

isCurrent returns a logical vector.

Examples

Run this code




obj <- new("VersionedBiobase")
isCurrent(obj)

isCurrent(1:10) # NA

A <- setClass("A", contains="VersionedBiobase",
         prototype=prototype(new("VersionedBiobase", versions=c(A="1.0.0"))))

a <- A()
classVersion(a)

isCurrent(a, "VersionedBiobase") # is the 'VersionedBiobase' portion current?
classVersion(a)["A"] <- "1.0.1"
classVersion(a)
isCurrent(a, "VersionedBiobase")
isCurrent(a) # more recent, so does not match 'current' defined by prototype

removeClass("A")

Run the code above in your browser using DataLab