Versioned              package:Biobase              R Documentation

Class "Versioned"

Description:

     Use this class as a `superclass' for classes requiring information
     about versions.

Methods:

     The following are defined; package developers may write additional
     methods.

     'new("Versioned", ..., versions=list())' Create a new
          'Versioned-class' instance, perhaps with additional named
          version elements (the contents of 'versions') added. Named
          elements of 'versions' are character strings that can be
          coerced using 'package_version', or 'package_version'
          instances.

     'classVersion(object)' Obtain version information about instance
          'object'. See 'classVersion'.

     'classVersion(object) <- value' Set version information on
          instance 'object' to 'value'; useful when 'object' is an
          instance of a class that contains 'VersionClass'. See
          'classVersion'.

     'classVersion(object)["id"] <- value' Create or update version
          information '"id"' on instance 'object' to 'value'; useful
          when 'object' is an instance of a class that contains
          'VersionClass'. See 'classVersion'.

     'show(object)' Default method returns 'invisible', to avoid
          printing confusing information when your own class does not
          have a 'show' method defined. Use 'classVersion(object)' to
          get or set version information.

Author(s):

     Biocore

See Also:

     'Versions-class'

Examples:

     obj <- new("Versioned", versions=list(A="1.0.0"))
     obj
     classVersion(obj)

     setClass("A", contains="Versioned")

     classVersion("A")
     a <- new("A")
     a # 'show' nothing by default
     classVersion(a)

     setClass("B",
              contains="Versioned",
              prototype=prototype(new("Versioned",versions=list(B="1.0.0"))))

     classVersion("B")
     b <- new("B")
     classVersion(b)

     classVersion(b)["B"] <- "1.0.1"
     classVersion(b)
     classVersion("B")

     classVersion("B") < classVersion(b)
     classVersion(b) == "1.0.1"

     setClass("C",
              representation(x="numeric"),
              contains=("VersionedBiobase"),
              prototype=prototype(new("VersionedBiobase", versions=c(C="1.0.1"))))

     setMethod("show", signature(object="C"),
               function(object) print(object@x))

     c <- new("C", x=1:10)

     c

     classVersion(c)

