read_qza: read qiime2 artifacts (.qza)

View source: R/read_qza.R

read_qzaR Documentation

read qiime2 artifacts (.qza)

Description

extracts embedded data and object metadata into an R session

Usage

read_qza(file, tmp, rm)

Arguments

file

path to the input file, ex: file="~/data/moving_pictures/table.qza"

tmp

a temporary directory that the object will be decompressed to (default="tempdir()")

rm

should the decompressed object be removed at completion of function (T/F default=TRUE)

Value

a named list of the following objects:

  • artifact$data - the raw data ex OTU table as matrix or tree in phylo format

  • artifact$uuid - the unique identifer of the artifact

  • artifact$type - the semantic type of the object (ex FeatureData[Sequence])

  • artifact$format - the format of the qiime artifact

  • artifact$provenance - information tracking how the object was created

  • artifact$contents - a table of all the files contained within the artifact and their file size

  • artifact$version - the reported version for the artifact, a warning error may be thrown if a new version is seen

Examples

## Not run: SVs<-read_qza("data/table.qza")

jbisanz/qiime2R documentation built on Dec. 17, 2024, 4:09 p.m.