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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/IO-methods.R
\name{write_biom}
\alias{write_biom}
\title{Write a biom-format v1 file, returning a \code{biom-class}.}
\usage{
write_biom(x, biom_file)
}
\arguments{
\item{x}{(Required). A biom object that is going to be written to file
as a proper biom formatted file, adhering to
\href{http://biom-format.org/documentation/biom_format.html}{the biom-format definition}.}
\item{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
\href{http://biom-format.org/documentation/biom_format.html}{the biom-format definition}}
}
\value{
Nothing. The first argument, \code{x}, is written to a file.
}
\description{
Write a biom-format v1 file, returning a \code{biom-class}.
}
\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)
}
\references{
\url{http://biom-format.org/}
}
\seealso{
Function to create a biom object from R data,
\code{\link{make_biom}}.
Definition of the
\code{\link{biom-class}}.
The \code{\link{read_biom}} import function.
Accessor functions like \code{\link{header}}.
}
|
