class-dependencies: Retrieve Class relationships

class-dependenciesR Documentation

Retrieve Class relationships

Description

As the title says it should do something with class relationships

Usage

buildClassDepGraph(class, includeUnions = FALSE)

buildClassDepData(class, includeUnions = FALSE)

buildClassDepFromPackage(pkg, includeUnions = FALSE)

plotClassDep(class, includeUnions = FALSE)

plotClassDepData(data)

plotClassDepGraph(g)

Arguments

class

a single character value defining a ‘S4’ class name

includeUnions

TRUE or FALSE: Should union definitions included in the result? (default: FALSE)

pkg

a single character value defining a package name

data

a data.frame with compatible columns. See output of buildClassDepData

g

an igraph object with compatible edge attributes. See output of buildClassDepGraph

Examples

library("SummarizedExperiment")
depData <- buildClassDepData("RangedSummarizedExperiment")
depData
g <- buildClassDepGraph("RangedSummarizedExperiment")
plotClassDepGraph(g)

seandavi/BiocPkgTools documentation built on May 23, 2024, 1:53 p.m.