Commit the man pages and make aggregate public again
This commit is contained in:
37
man/samples-methods.Rd
Normal file
37
man/samples-methods.Rd
Normal file
@@ -0,0 +1,37 @@
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/02_class_metabarcoding.data.R
|
||||
\docType{methods}
|
||||
\name{samples,metabarcoding.data-method}
|
||||
\alias{samples,metabarcoding.data-method}
|
||||
\alias{samples-methods,metabarcoding.data}
|
||||
\title{Extracts the samples description data.frame}
|
||||
\usage{
|
||||
\S4method{samples}{metabarcoding.data}(obj)
|
||||
}
|
||||
\arguments{
|
||||
\item{obj}{a \code{\link{metabarcoding.data}} instance}
|
||||
}
|
||||
\value{
|
||||
a data.frame containing data about sample
|
||||
}
|
||||
\description{
|
||||
Extract the sample description 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 samples
|
||||
d = samples(termes)
|
||||
|
||||
head(d)
|
||||
|
||||
}
|
||||
\seealso{
|
||||
\code{\link{metabarcoding.data}},
|
||||
\code{\link{motus}}, \code{\link{reads}}
|
||||
}
|
||||
\author{
|
||||
Eric Coissac
|
||||
}
|
Reference in New Issue
Block a user