Commit the man pages and make aggregate public again
This commit is contained in:
34
man/motu-methods.Rd
Normal file
34
man/motu-methods.Rd
Normal file
@@ -0,0 +1,34 @@
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/02_class_metabarcoding.data.R
|
||||
\docType{methods}
|
||||
\name{motus,metabarcoding.data-method}
|
||||
\alias{motus,metabarcoding.data-method}
|
||||
\alias{motu-methods,metabarcoding.data}
|
||||
\title{Extracts the MOTU descriptions \code{data.frame}}
|
||||
\usage{
|
||||
\S4method{motus}{metabarcoding.data}(obj)
|
||||
}
|
||||
\arguments{
|
||||
\item{obj}{a \code{\link{metabarcoding.data}} instance}
|
||||
}
|
||||
\value{
|
||||
a data.frame containing data about MOTU
|
||||
}
|
||||
\description{
|
||||
Extract the MOTUs description \code{data.frame} from a
|
||||
\code{\link{metabarcoding.data}} instance.
|
||||
}
|
||||
\examples{
|
||||
# load termite data set from the ROBITools sample data
|
||||
data(termes)
|
||||
|
||||
# Extract the data.frame describing MOTUs
|
||||
d = motus(termes)
|
||||
|
||||
head(d)
|
||||
|
||||
}
|
||||
\seealso{
|
||||
\code{\link{metabarcoding.data}},
|
||||
\code{\link{reads}}, \code{\link{samples}}
|
||||
}
|
Reference in New Issue
Block a user