QIIME 2 Studio (q2studio)¶
This guide assumes you have performed the steps in the Moving Pictures tutorial. The
table.qza file generated in that tutorial is used here.
QIIME 2 Studio (
q2studio) is a graphical user interface for QIIME 2. This document will show you how to install and use QIIME 2 Studio as a desktop application.
QIIME 2 Studio currently requires a source installation. In the future, we will provide a package distribution/installer which will greatly simplify the installation process presented here. An experimental build of QIIME 2 Studio is available as a pre-installed package in the VirtualBox image.
Launching QIIME 2 Studio requires an active
conda environment with QIIME 2 installed in it. Failure to activate a compatible
conda environment will likely produce errors, and possibly cause the application to crash. If you have not activated your
conda environment already, please do so now:
conda activate qiime2-2021.8
Please note, your
conda environment might have a name other than
qiime2-2021.8, if you or your system administrator provided one during installation of QIIME 2.
Once you have installed
Node.js >= 5 you will need to download and extract the interface’s source:
Download URL: https://codeload.github.com/qiime2/q2studio/zip/2021.8.0
Save as: q2studio-2021.8.0.zip
wget \ -O "q2studio-2021.8.0.zip" \ "https://codeload.github.com/qiime2/q2studio/zip/2021.8.0"
curl -sL \ "https://codeload.github.com/qiime2/q2studio/zip/2021.8.0" > \ "q2studio-2021.8.0.zip"
unzip q2studio-2021.8.0.zip && rm q2studio-2021.8.0.zip cd q2studio-2021.8.0
Next we need to install it (both as a Python package, and as a Node.js package):
conda install gevent nodejs -c defaults --override-channels pip install . npm install --legacy-peer-deps && npm run build
Finally we will be able to launch the interface with:
This will bring up a new window that looks like the following:
There are four sections to this interface. At the top you are able to select the directory in which you want to work. By default it starts in your home directory, but we want to change it to the directory where the Moving Pictures tutorial was run. To do so, click the Change Directory button and navigate to that directory.
The next component of this interface are the available plugins. Clicking on a plugin reveals the available methods and visualizers. Notice that these are the same plugins and methods/visualizers that are available through the command line interface (and other QIIME 2 interfaces).
In the middle of the interface we have the job pane. You can choose between
Finished Jobs, and
Failed Jobs. As we have not run anything yet, each tab is currently empty.
Finally in the bottom pane you’ll see the artifacts and visualizations in the current directory. These
.qzv files are the ones generated from the Moving Pictures tutorial.
Rarefy table method from the
feature-table plugin, which will change the page to look like the following:
On this page, you’ll select your inputs and name your outputs. The inputs corresponding to QIIME 2 artifacts (
Input Artifact: table on this method) will be populated with the available artifacts that are of the correct semantic type. Select the
table.qza artifact that was generated in the Moving Pictures tutorial as the input artifact. Fill in a rarefaction depth (
sampling depth) of 100, name the output file
rarefied_table_100, and click
Go!. This starts a job which will show in the
Active Jobs tab until it completes, after which it will appear in the
Finished Jobs tab (or
Failed Jobs tab if something went wrong).
You can select a job by clicking on it, bringing up a new window describing further details:
Try using the QIIME 2 Studio to experiment with other plugins!