header-methods: Extract the header from a 'biom-class' object as a list.

In biomformat: An interface package for the BIOM file format

Description

Extract the header from a biom-class object as a list.

Usage

header(x)

## S4 method for signature 'biom'
header(x)

Arguments

x	(Required). An instance of the biom-class.

Value

A list containing the header data. That is, all the required elements that are not the main data or index metadata.

Examples

biom_file = system.file("extdata", "rich_sparse_otu_table.biom", package = "biomformat")
x = read_biom(biom_file)
header(x)

biomformat documentation built on Nov. 8, 2020, 7:43 p.m.