write_biom: Write a biom-format v1 file, returning a 'biom-class'.

View source: R/IO-methods.R

write_biomR Documentation

Write a biom-format v1 file, returning a biom-class.

Description

Write a biom-format v1 file, returning a biom-class.

Usage

write_biom(x, biom_file)

Arguments

x

(Required). A biom object that is going to be written to file as a proper biom formatted file, adhering to the biom-format definition.

biom_file

(Required). A character string indicating the file location of the biom formatted file. This is a JSON formatted file specific to biological datasets. The format is formally defined at the biom-format definition

Value

Nothing. The first argument, x, is written to a file.

References

http://biom-format.org/

See Also

Function to create a biom object from R data, make_biom.

Definition of the biom-class.

The read_biom import function.

Accessor functions like header.

Examples

biom_file <- system.file("extdata", "rich_sparse_otu_table.biom", package = "biomformat")
x = read_biom(biom_file)
outfile = tempfile()
write_biom(x, outfile)
y = read_biom(outfile)
identical(x, y)

joey711/biomformat documentation built on Aug. 21, 2023, 2:24 p.m.