Commit 574f654b by Eric Coissac

doc change

parent cd0102cf
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/procmod.frame.R
\name{.procmod_coerce_value}
\alias{.procmod_coerce_value}
\title{Internal function coercing the data to a matrix.}
\usage{
.procmod_coerce_value(x, nrows = 0, contrasts = NULL)
}
\arguments{
\item{x}{The data to coerce}
\item{nrows}{an interger value specifying the number of row
of the returned matrix}
}
\value{
a new numeric matrix with correct size.
}
\description{
Transforme the \code{x} value into a \code{numeric matrix} of
the correct size or into a \code{dist} object.
}
\author{
Eric Coissac <eric.coissac@metabarcoding.org>
Christelle Gonindard-Melodelima <christelle.gonindard@metabarcoding.org>
}
...@@ -4,16 +4,16 @@ ...@@ -4,16 +4,16 @@
\alias{.rep_matrix} \alias{.rep_matrix}
\title{Internal function repeating a matrix.} \title{Internal function repeating a matrix.}
\usage{ \usage{
.rep_matrix(x, length.out) .rep_matrix(x, nrow)
} }
\arguments{ \arguments{
\item{x}{The matrix to replicate} \item{x}{The matrix to replicate}
\item{length.out}{an interger value specifying the number of row \item{nrow}{an interger value specifying the number of row
of the returned matrix} of the returned matrix}
} }
\value{ \value{
a new matrix with the same number of columns but with `length.out` a new matrix with the same number of columns but with `nrow`
rows. rows.
} }
\description{ \description{
...@@ -23,7 +23,7 @@ repeats several times the rows of a matrix ...@@ -23,7 +23,7 @@ repeats several times the rows of a matrix
initial row count initial row count
} }
\author{ \author{
Eric Coissac Eric Coissac <eric.coissac@metabarcoding.org>
Christelle Gonindard-Melodelima Christelle Gonindard-Melodelima <christelle.gonindard@metabarcoding.org>
} }
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/model.procmod.R
\name{.transformData}
\alias{.transformData}
\title{Transform raw data to be projected in an orthogonal space.}
\usage{
.transformData(x)
}
\arguments{
\item{x}{the table to transform}
}
\value{
a numeric matrix
}
\description{
The function follow two recepies according to the class of \code{x}.
If x is a distance objet or a \code{data.frame} with an attribute \code{is.dist}
set to \code{TRUE}, the matrice is projected using the \code{\link{ortho.dist}} method.
Otherwise, the data are just projected using a PCA.
}
\note{
Internal function, do not use.
}
\seealso{
\code{\link{ortho.dist}}
\code{\link{pca}}
}
\author{
Eric Coisaac <eric.coissac@metabarcoding.org>
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment