- due to changes in struct (removal of unicode)
Gavin Rhys Lloyd authored on 02/02/2024 10:50:50
| ... | ... |
@@ -28,7 +28,7 @@ contains information orthogonal to the input vector, and the other is non-orthog |
| 28 | 28 |
\section{Inheritance}{
|
| 29 | 29 |
|
| 30 | 30 |
A \code{OPLSDA} object inherits the following \code{struct} classes: \cr\cr
|
| 31 |
-\code{OPLSDA()} ⭢ \code{OPLSR()} ⭢ \code{model()} ⭢ \code{struct_class()}
|
|
| 31 |
+\verb{[OPLSDA]} >> \verb{[OPLSR]} >> \verb{[model]} >> \verb{[struct_class]}
|
|
| 32 | 32 |
} |
| 33 | 33 |
|
| 34 | 34 |
\examples{
|
- get_description moved to struct and updated
Gavin Rhys Lloyd authored on 31/01/2024 09:48:31
| ... | ... |
@@ -7,7 +7,7 @@ |
| 7 | 7 |
OPLSDA(number_components = 1, factor_name, ...) |
| 8 | 8 |
} |
| 9 | 9 |
\arguments{
|
| 10 |
-\item{number_components}{(numeric, integer) The number of orthgonal components. The default is \code{1}.}
|
|
| 10 |
+\item{number_components}{(numeric, integer) The number of orthgonal components. The default is \code{1}.\cr}
|
|
| 11 | 11 |
|
| 12 | 12 |
\item{factor_name}{(character) The name of a sample-meta column to use.}
|
| 13 | 13 |
|
| ... | ... |
@@ -25,6 +25,16 @@ A \code{OPLSDA} object with the following \code{output} slots:
|
| 25 | 25 |
OPLS splits a data matrix into two parts. One part |
| 26 | 26 |
contains information orthogonal to the input vector, and the other is non-orthogonal. |
| 27 | 27 |
} |
| 28 |
+\section{Inheritance}{
|
|
| 29 |
+ |
|
| 30 |
+A \code{OPLSDA} object inherits the following \code{struct} classes: \cr\cr
|
|
| 31 |
+\code{OPLSDA()} ⭢ \code{OPLSR()} ⭢ \code{model()} ⭢ \code{struct_class()}
|
|
| 32 |
+} |
|
| 33 |
+ |
|
| 28 | 34 |
\examples{
|
| 35 |
+M = OPLSDA( |
|
| 36 |
+ number_components = 2, |
|
| 37 |
+ factor_name = "V1") |
|
| 38 |
+ |
|
| 29 | 39 |
M = OPLSR('number_components'=2,factor_name='Species')
|
| 30 | 40 |
} |
due to roxygen no longer needing % to be escaped.
- add markdown flag to description file
- use text format for citations (includes markdown)
- remove % from descriptions (doesnt work with current implementation)
Gavin Rhys Lloyd authored on 06/07/2023 15:19:12
| ... | ... |
@@ -22,8 +22,8 @@ A \code{OPLSDA} object with the following \code{output} slots:
|
| 22 | 22 |
} |
| 23 | 23 |
} |
| 24 | 24 |
\description{
|
| 25 |
-OPLS splits a data matrix into two parts. One part |
|
| 26 |
- contains information orthogonal to the input vector, and the other is non-orthogonal. |
|
| 25 |
+OPLS splits a data matrix into two parts. One part |
|
| 26 |
+contains information orthogonal to the input vector, and the other is non-orthogonal. |
|
| 27 | 27 |
} |
| 28 | 28 |
\examples{
|
| 29 | 29 |
M = OPLSR('number_components'=2,factor_name='Species')
|
Gavin Rhys Lloyd authored on 23/01/2023 10:57:37
| 1 | 1 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,30 @@ |
| 1 |
+% Generated by roxygen2: do not edit by hand |
|
| 2 |
+% Please edit documentation in R/oplsda_class.R |
|
| 3 |
+\name{OPLSDA}
|
|
| 4 |
+\alias{OPLSDA}
|
|
| 5 |
+\title{Orthogonal Partial Least Squares regression}
|
|
| 6 |
+\usage{
|
|
| 7 |
+OPLSDA(number_components = 1, factor_name, ...) |
|
| 8 |
+} |
|
| 9 |
+\arguments{
|
|
| 10 |
+\item{number_components}{(numeric, integer) The number of orthgonal components. The default is \code{1}.}
|
|
| 11 |
+ |
|
| 12 |
+\item{factor_name}{(character) The name of a sample-meta column to use.}
|
|
| 13 |
+ |
|
| 14 |
+\item{...}{Additional slots and values passed to \code{struct_class}.}
|
|
| 15 |
+} |
|
| 16 |
+\value{
|
|
| 17 |
+A \code{OPLSDA} object with the following \code{output} slots:
|
|
| 18 |
+\tabular{ll}{
|
|
| 19 |
+\code{opls_model} \tab (list) \cr
|
|
| 20 |
+\code{filtered} \tab (DatasetExperiment) \cr
|
|
| 21 |
+\code{orthogonal} \tab (DatasetExperiment) \cr
|
|
| 22 |
+} |
|
| 23 |
+} |
|
| 24 |
+\description{
|
|
| 25 |
+OPLS splits a data matrix into two parts. One part |
|
| 26 |
+ contains information orthogonal to the input vector, and the other is non-orthogonal. |
|
| 27 |
+} |
|
| 28 |
+\examples{
|
|
| 29 |
+M = OPLSR('number_components'=2,factor_name='Species')
|
|
| 30 |
+} |