Exporting data¶
Warning
This site has been replaced by the new QIIME 2 “amplicon distribution” documentation, as of the 2025.4 release of QIIME 2. You can still access the content from the “old docs” here for the QIIME 2 2024.10 and earlier releases, but we recommend that you transition to the new documentation at https://amplicon-docs.qiime2.org. Content on this site is no longer updated and may be out of date.
Are you looking for:
the QIIME 2 homepage? That’s https://qiime2.org.
learning resources for microbiome marker gene (i.e., amplicon) analysis? See the QIIME 2 amplicon distribution documentation.
learning resources for microbiome metagenome analysis? See the MOSHPIT documentation.
installation instructions, plugins, books, videos, workshops, or resources? See the QIIME 2 Library.
general help? See the QIIME 2 Forum.
Old content beyond this point… 👴👵
Note
This tutorial assumes you have installed QIIME 2 using one of the procedures in the install documents.
In order to use QIIME 2, your input data must be stored in QIIME 2 artifacts (i.e. .qza
files). This is what enables distributed and automatic provenance tracking, as well as semantic type validation and transformations between data formats (see the core concepts page for more details about QIIME 2 artifacts).
Sometimes you’ll want to export data from a QIIME 2 artifact, for example to analyze data with a different microbiome analysis program, or to do statistical analysis in R. This can be achieved used the qiime tools export
command, which takes a QIIME 2 artifact (.qza
) file and an output directory as input. The data in the artifact will exported to one or more files depending on the specific artifact.
Warning
When exporting data from a QIIME 2 artifact, there will no longer be provenance associated with the data. If you subsequently re-import the exported data, the provenance associated with the new artifact will begin with the import step and all existing provenance will be lost. It’s therefore best to only export data from artifacts when you are done with all processing steps that can be achieved with QIIME 2 to maximize the value of each artifact’s provenance.
The following sections provide examples of exporting data from QIIME 2 artifacts. It is possible to export data from any QIIME 2 artifact or visualization; the process is the same as what is described below.
Exporting a feature table¶
A FeatureTable[Frequency]
artifact will be exported as a BIOM v2.1.0 formatted file.
Download URL: https://data.qiime2.org/2024.10/tutorials/exporting/feature-table.qza
Save as: feature-table.qza
wget \
-O "feature-table.qza" \
"https://data.qiime2.org/2024.10/tutorials/exporting/feature-table.qza"
curl -sL \
"https://data.qiime2.org/2024.10/tutorials/exporting/feature-table.qza" > \
"feature-table.qza"
qiime tools export \
--input-path feature-table.qza \
--output-path exported-feature-table
Exporting a phylogenetic tree¶
A Phylogeny[Unrooted]
artifact will be exported as a newick formatted file.
Download URL: https://data.qiime2.org/2024.10/tutorials/exporting/unrooted-tree.qza
Save as: unrooted-tree.qza
wget \
-O "unrooted-tree.qza" \
"https://data.qiime2.org/2024.10/tutorials/exporting/unrooted-tree.qza"
curl -sL \
"https://data.qiime2.org/2024.10/tutorials/exporting/unrooted-tree.qza" > \
"unrooted-tree.qza"
qiime tools export \
--input-path unrooted-tree.qza \
--output-path exported-tree
Exporting versus extracting¶
QIIME 2 artifacts can be extracted using qiime tools extract
. Extracting an artifact differs from exporting an artifact. When exporting an artifact, only the data files will be placed in the output directory. Extracting will additionally provide QIIME 2’s metadata about an artifact, including for example the artifact’s provenance, in the output directory in plain-text formats. An artifact can be extracted as follows. The directory that you’re extracting to must already exist.
mkdir extracted-feature-table
qiime tools extract \
--input-path feature-table.qza \
--output-path extracted-feature-table
The output directory will contain a new directory whose name is the artifact’s UUID. All artifact data and metadata will be stored in that directory.
Note
While it is possible to view an artifact’s provenance from its extracted metadata text files, the graphical provenance viewer at https://view.qiime2.org is the recommended way to view an artifact’s provenance.