subClasses {classGraph}R Documentation

All Subclasses of a Given S4 Class

Description

Usage

subClasses(Cl, directOnly = TRUE, complete = TRUE, ...)

Arguments

Cl a class representation or a class name (character).
directOnly logical indicating if you direct subclasses are desired (or also the ones with distance > 1).
complete logical,.. as in....
... ........

Value

~Describe the value returned If it is a LIST, use

comp1 Description of 'comp1'
comp2 Description of 'comp2'

...

Author(s)

Martin Maechler

See Also

superClasses; Classes in general.

Examples

##---- Should be DIRECTLY executable !! ----
##-- ==>  Define data, use random,
##--    or do  help(data=index)  for the standard data sets.

## The function is currently defined as
function (Cl, directOnly = TRUE, complete = TRUE, ...)
{
    if (isClassDef(Cl)) {
        cDef <- Cl
        Cl <- cDef@className
    }
    else {
        cDef <- if (complete)
            getClass(Cl)
        else getClassDef(Cl)
    }
    subs <- showExtends(cDef@subclasses, printTo = FALSE)
    if (directOnly)
        subs$what[subs$how == "directly"]
    else subs$what
  }

[Package classGraph version 0.7-0 Index]