getFactors: getFactors

In bioFAM/MOFA: Multi-Omics Factor Analysis (MOFA)

Description

Extract the latent factors from the model.

Usage

getFactors(object, factors = "all", as.data.frame = FALSE)

Arguments

object	a trained MOFAmodel object.
factors	character vector with the factor name(s), or numeric vector with the factor index(es). Default is "all".
as.data.frame	logical indicating whether to return a long data frame instead of a matrix. Default is FALSE.

Value

By default it returns the latent factor matrix of dimensionality (N,K), where N is number of samples and K is number of factors.
Alternatively, if as.data.frame is TRUE, returns a long-formatted data frame with columns (sample,factor,value).

Examples

# load a trained MOFAmodel object
filepath <- system.file("extdata", "CLL_model.hdf5", package = "MOFAdata")
MOFAobject <- loadModel(filepath)
# get factors as matrix
getFactors(MOFAobject, factors = 1:3)
# get factors as data.frame
head(getFactors(MOFAobject, factors = 1:5, as.data.frame = TRUE))

bioFAM/MOFA documentation built on Oct. 3, 2020, 12:53 a.m.