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
|
% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/BIOM-class.R
\docType{methods}
\name{header}
\alias{header}
\alias{header,biom-method}
\title{Extract the header from a \code{\link{biom-class}} object as a list.}
\usage{
header(x)
\S4method{header}{biom}(x)
}
\arguments{
\item{x}{(Required). An instance of the \code{\link{biom-class}}.}
}
\value{
A list containing the header data.
That is, all the required elements that are not
the main data or index metadata.
}
\description{
Extract the header from a \code{\link{biom-class}} object as a list.
}
\examples{
biom_file = system.file("extdata", "rich_sparse_otu_table.biom", package = "biomformat")
x = read_biom(biom_file)
header(x)
}
|
