File: ResidualMatrix.Rd

package info (click to toggle)
r-bioc-biocsingular 1.6.0%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 364 kB
  • sloc: cpp: 57; sh: 13; makefile: 2
file content (36 lines) | stat: -rw-r--r-- 845 bytes parent folder | download | duplicates (3)
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
\name{ResidualMatrix}

\alias{ResidualMatrixSeed}
\alias{ResidualMatrix}

\docType{class}

\title{The ResidualMatrix class}
\description{
This class is deprecated, see the exact same class in the \pkg{ResidualMatrix} package.
}

\usage{
ResidualMatrixSeed(x, design=NULL)

ResidualMatrix(x, design=NULL)
}

\arguments{
\item{x}{A matrix-like object.

This can alternatively be a ResidualMatrixSeed, in which case \code{design} is ignored.}
\item{design}{A numeric matrix containing the experimental design,
to be used for linear model fitting on each \emph{column} of \code{x}.}
}

\value{
The \code{ResidualMatrixSeed} constructor will return a ResidualMatrixSeed object.

The \code{ResidualMatrix} constructor will return a ResidualMatrix object,
containing values equivalent to \code{lm.fit(x=design, y=x)$residuals}.
}

\author{
Aaron Lun
}