STATegRa (version 1.0.0)

getMethodInfo: Retrieve information about the components analysis done using omicsCompAnalysis from an caClass-class

Description

Generic function to retrieve information about the method and the number of components (common and individual) employed in the omicsCompAnalysis from an caClass-class

Usage

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

Arguments

x

caClass-class object. If only this parameter is specified all information about the method and number of components is diplayed

method

Logical indicating if method employed has to be returned (FALSE by default)

comps

Character indicating which components number has to be returned (The options are: "common" for common components, "distinctive" for distinctive components

block

Character indicating the block of data whose number of components has to be returned. It can be specified by using the position of the block ("1" or "2") or the name assigned to this block in the caClass-class object. If it is NULL both number of distinctive components are displayed

Value

It returns a list with the information indicated by the parameters. By default a list with the following components:

method

The component analysis method used for the analysis

comps

Number of components (common and distinctive) used as input for the method

See Also

omicsCompAnalysis, caClass-class

Examples

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")