-
Notifications
You must be signed in to change notification settings - Fork 4
/
OPLSR.Rd
40 lines (35 loc) · 1.16 KB
/
OPLSR.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/oplsr_class.R
\name{OPLSR}
\alias{OPLSR}
\title{Orthogonal Partial Least Squares regression}
\usage{
OPLSR(number_components = 2, factor_name, ...)
}
\arguments{
\item{number_components}{(numeric, integer) The number of orthgonal components. The default is \code{2}.\cr}
\item{factor_name}{(character) The name of a sample-meta column to use.}
\item{...}{Additional slots and values passed to \code{struct_class}.}
}
\value{
A \code{OPLSR} object with the following \code{output} slots:
\tabular{ll}{
\code{opls_model} \tab (list) \cr
\code{filtered} \tab (DatasetExperiment) \cr
\code{orthogonal} \tab (DatasetExperiment) \cr
}
}
\description{
OPLS splits a data matrix into two parts. One part
contains information orthogonal to the input vector, and the other is non-orthogonal.
}
\section{Inheritance}{
A \code{OPLSR} object inherits the following \code{struct} classes: \cr\cr
\verb{[OPLSR]} >> \verb{[model]} >> \verb{[struct_class]}
}
\examples{
M = OPLSR(
number_components = 2,
factor_name = "V1")
M = OPLSR('number_components'=2,factor_name='Species')
}