|
a |
|
b/OmicsFold/man/get.model.variance.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/feature_loadings.R |
|
|
3 |
\name{get.model.variance} |
|
|
4 |
\alias{get.model.variance} |
|
|
5 |
\title{Get model variance} |
|
|
6 |
\usage{ |
|
|
7 |
get.model.variance(tuned.model, block = "X") |
|
|
8 |
} |
|
|
9 |
\arguments{ |
|
|
10 |
\item{tuned.model}{Either an sPLS-DA model from singleomics or a DIABLO model |
|
|
11 |
from multiomics.} |
|
|
12 |
|
|
|
13 |
\item{block}{Where the model type is DIABLO, the block to get model variance |
|
|
14 |
for.} |
|
|
15 |
} |
|
|
16 |
\value{ |
|
|
17 |
A data frame with the model variance for the specified block. |
|
|
18 |
} |
|
|
19 |
\description{ |
|
|
20 |
Get percent of variance explained by each component for a tuned model. Works |
|
|
21 |
with sPLS-DA models or DIABLO models as input, but the block parameter must |
|
|
22 |
be specified for DIABLO models. |
|
|
23 |
} |
|
|
24 |
\examples{ |
|
|
25 |
\dontrun{ |
|
|
26 |
get.model.variance(splsda.model) |
|
|
27 |
get.model.variance(diablo.model, block = 'transcriptomics') |
|
|
28 |
} |
|
|
29 |
} |