getMethodInfo: Retrieve information about component analysis method

Description Usage Arguments Value Author(s) See Also Examples

Description

Generic function to retrieve information about the method used by omicsCompAnalysis on a caClass-class object.

Usage

1
getMethodInfo(x, method=FALSE, comps=NULL, block=NULL)

Arguments

x

caClass-class object.

method

Logical indicating whether to return the method name.

comps

Character indicating which component number to return ("common", "distinctive" or "all")

block

Character indicating the block of data for which the component count will be given. It can be specified by the position of the block ("1" or "2") or the name assigned in the caClass-class object. If it is NULL both blocks are displayed.

Value

A list containing the requested information.

Author(s)

Patricia Sebastian-Leon

See Also

omicsCompAnalysis, caClass-class

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
data("STATegRa_S3")
B1 <- createOmicsExpressionSet(Data=Block1.PCA, pData=ed.PCA,
                               pDataDescr=c("classname"))
B2 <- createOmicsExpressionSet(Data=Block2.PCA,
                               pData=ed.PCA, pDataDescr=c("classname"))
# Omics components analysis
res <- omicsCompAnalysis(Input=list(B1, B2), Names=c("expr", "mirna"),
                         method="DISCOSCA", Rcommon=2, Rspecific=c(2, 2),
                         center=TRUE, scale=TRUE, weight=TRUE)
getMethodInfo(res)
getMethodInfo(res, method=TRUE)
getMethodInfo(res, comps="all", block="expr")

lunacab/STATegRa documentation built on May 5, 2019, 2:42 a.m.