Skip to content

Commit a36a69a

Browse files
authored
Merge pull request #139 from megantranvu/qiime2
QIIME2 Tutorial + Notes
2 parents aa17d84 + 33bc8c6 commit a36a69a

File tree

14 files changed

+250
-5
lines changed

14 files changed

+250
-5
lines changed

.gitignore

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
.DS_Store
2-
Thumbs.db
3-
public/
4-
.*.swp
5-
resources/
1+
.DS_Store
2+
Thumbs.db
3+
public/
4+
.*.swp
5+
resources/
6+
venv/

content/notes/qiime2/1_intro.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: What is QIIME 2?
3+
date: 2025-06-13-14:45:04Z
4+
type: docs
5+
weight: 50
6+
menu:
7+
qiime2:
8+
---
9+
10+
[QIIME 2](https://qiime2.org) is a powerful, extensible, and decentralized microbiome analysis package with a focus on data and analysis transparency. QIIME 2 enables researchers to start an analysis with raw DNA sequence data and finish with publication-quality figures and statistical results.
11+
12+
{{< figure src=/notes/qiime2/img/logo.png width=70% height=70% >}}
13+
14+
15+
__Key features:__
16+
17+
* Integrated and automatic tracking of data provenance
18+
* Semantic type system
19+
* Plugin system for extending microbiome analysis functionality
20+
* Support for multiple types of user interfaces (e.g. API, command line, graphical)
21+
22+
23+
QIIME 2 is a complete redesign and rewrite of the [QIIME 1](http://qiime.org/) microbiome analysis pipeline. QIIME 2 addresses many of the limitations of QIIME 1, while retaining the features that makes QIIME 1 a powerful and widely-used analysis pipeline.
24+
25+
__High-level features:__
26+
27+
* Latest and greatest microbiome bioinformatics methods and visualizations
28+
* Accessibility through accurate, detailed, and interesting documentation and well-designed interfaces
29+
* A community of microbiome scientists, developers, and bioinformaticians
30+
31+
32+
__Interfaces__
33+
34+
QIIME 2 has many available interfaces. Choose the interface that helps you work most efficiently.
35+
36+
{{< figure src=/notes/qiime2/img/interfaces.png width=70% height=70% >}}
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: QIIME 2 Core 2022.8 Distribution
3+
date: 2025-06-13-14:45:04Z
4+
type: docs
5+
weight: 100
6+
menu:
7+
qiime2:
8+
---
9+
10+
The QIIME 2 Core 2022.8 distribution includes the QIIME 2 framework, q2cli (a QIIME 2 command-line interface), and the following plugins:
11+
12+
* q2-alignment
13+
* q2-composition
14+
* q2-cutadapt
15+
* q2-dada2
16+
* q2-deblur
17+
* q2-demux
18+
* q2-diversity
19+
* q2-diversity-lib
20+
* q2-emperor
21+
* q2-empress
22+
* q2-feature-classifier
23+
* q2-feature-table
24+
* q2-fragment-insertion
25+
* q2-gneiss
26+
* q2-longitudinal
27+
* q2-metadata
28+
* q2-phylogeny
29+
* q2-picrust2
30+
* q2-quality-control
31+
* q2-quality-filter
32+
* q2-sample-classifier
33+
* q2-taxa
34+
* q2-types
35+
* q2-vsearch
36+
37+
38+
The QIIME 2 Core 2022.8 distribution includes plugins and interfaces that are developed, maintained, tested, and distributed by the QIIME 2 development team. The Core distribution is necessary to run the commands in the QIIME 2 tutorials. If there are additional QIIME 2 plugins or interfaces you would like to install, please consult the relevant package(s) documentation. Other types of distributions may be made available in the future in addition to Core.
39+
40+
{{< figure src=/notes/qiime2/img/cli.png caption="The QIIME 2 command-line interface helps you work on Rivanna." width=70% height=70% >}}
41+
42+
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Importing Data
3+
date: 2025-06-13-14:45:04Z
4+
type: docs
5+
weight: 150
6+
menu:
7+
qiime2:
8+
---
9+
10+
Data produced by QIIME 2 exist as **QIIME 2 artifacts**. A QIIME 2 artifact contains data and metadata. The metadata describes things about the data, such as its type, format, and how it was generated (provenance). A QIIME 2 artifact typically has the .qza or .qzv file extension when stored in a zip file.
11+
12+
Since QIIME 2 works with artifacts instead of data files (e.g. FASTA files), you must create a QIIME 2 artifact by importing data. You can import data at any step in an analysis, though typically you will start by importing raw sequence data. QIIME 2 also has tools to export data from an artifact. See the [QIIME 2 Importing Guide](https://docs.qiime2.org/2022.8/tutorials/importing/) for details on how to import data.
13+
14+
Note: if you are having trouble unzipping the file, you can run this line in your command line.
15+
```bash
16+
qiime tools extract
17+
```
18+
19+
For more information, visit [https://dev.qiime2.org/latest/storing-data/](https://dev.qiime2.org/latest/storing-data/
20+
)
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: View QIIME 2 Results
3+
date: 2025-06-13-14:45:04Z
4+
type: docs
5+
weight: 250
6+
menu:
7+
qiime2:
8+
---
9+
10+
[QIIME 2 View](https://view.qiime2.org) is a read-only web interface that can be used to view QIIME 2 results, even if you don't have QIIME 2 installed.
11+
12+
{{< figure src=/notes/qiime2/img/view.png width=70% height=70% >}}
13+
14+
__Features:__
15+
* Reads QIIME 2 outputs (QZAs and QZVs)
16+
* No installation required
17+
* Easily share links using Dropbox with collaborators
18+
* No uploading (your data stays on your computer)
19+

content/notes/qiime2/5_practice.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Hands-On Practice
3+
date: 2025-06-13-14:45:04Z
4+
type: docs
5+
weight: 300
6+
menu:
7+
qiime2:
8+
---
9+
10+
Copy the following files to your home directory:
11+
12+
```bash
13+
cp -rp  /project/rivanna-training/singularity_qiime2 ./
14+
```
15+
16+
Then submit the job to run:
17+
18+
```bash
19+
sbatch q2-import.slurm
20+
```

content/notes/qiime2/_index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Introduction to QIIME 2
3+
date: 2025-6-10T00:00:00-05:00
4+
authors: []
5+
type: docs
6+
weight: 1
7+
date: 2025-6-10T00:00:00-05:00
8+
9+
menu:
10+
qiime2:
11+
---
12+
13+
14+
In this tutorial, we will be discussing the following topics:
15+
* What is QIIME 2
16+
* How to import data into QIIME 2
17+
* How to view QIIME 2 results

content/notes/qiime2/img/cli.png

142 KB
Loading
121 KB
Loading

content/notes/qiime2/img/logo.png

14.7 KB
Loading

0 commit comments

Comments
 (0)