samples_ids_colname.Rd 1.09 KB
Newer Older
1
% Generated by roxygen2: do not edit by hand
Eric Coissac's avatar
Eric Coissac committed
2 3
% Please edit documentation in R/robimetabar.R, R/metabar_data_class.R
\name{samples_ids_colname.robimetabar}
4 5
\alias{samples_ids_colname.robimetabar}
\alias{samples_ids.robimetabar}
Eric Coissac's avatar
Eric Coissac committed
6 7
\alias{samples_ids_colname}
\alias{samples_ids}
8 9
\title{Returns sample ids column name}
\usage{
10 11 12
\method{samples_ids_colname}{robimetabar}(object)

\method{samples_ids}{robimetabar}(object)
Eric Coissac's avatar
Eric Coissac committed
13 14 15 16

samples_ids_colname(data)

samples_ids(data)
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
}
\arguments{
\item{data}{a metabar object}
}
\value{
a charactere value
}
\description{
The structure describing samples in a metabar object
contains a column containing the sample's names.
\code{sample_ids_name} returns the name of that column.
}
\examples{
  reads <- matrix(1:12, nrow = 3)
  rownames(reads) <- c("sample_1", "sample_2", "sample_3")
  colnames(reads) <- c("motu_1", "motu_2", "motu_3", "motu_4")

  metabar <- robimetabar(reads = reads)
  sample_ids_name(metabar)

}
\seealso{
\code{\link[ROBITools2]{motu_ids_name}},\code{\link[ROBITools2]{motu_ids}},
         \code{\link[ROBITools2]{sample_ids}}
}
\author{
43 44
Eric Coissac

45 46
Eric Coissac
}