|
1 | | - |
2 | | -.. QIIME documentation master file, created by |
3 | | - sphinx-quickstart on Mon Jan 25 12:57:02 2010. |
4 | | - You can adapt this file completely to your liking, but it should at least |
5 | | - contain the root `toctree` directive. |
6 | | -
|
7 | 1 | ################################################### |
8 | 2 | QIIME: Quantitative Insights Into Microbial Ecology |
9 | 3 | ################################################### |
10 | | -QIIME (canonically pronounced 'Chime') is a pipeline for performing microbial community analysis that integrates many third party tools which have become standard in the field. QIIME can run on a laptop, a supercomputer, and systems in between such as multicore desktops. Linux and Mac OS X are supported natively, and Windows, Linux, and Mac OS X are supported via the `QIIME virtual box <./install/virtual_box.html>`_. |
11 | | - |
12 | | -**The quickest way to start using QIIME is with the** `QIIME virtual box <./install/virtual_box.html>`_. To stay up-to-date on what's new with QIIME, you should subscribe to the `blog <http://qiime.wordpress.com>`_. |
13 | | - |
14 | | -Rather than reimplementing commonly used algorithms, QIIME wraps popular implementations of those algorithms. This allows us to make use of the many excellent tools available in this area, and allows faster integration of new tools. If you use tools that you think would be useful additions to QIIME, consider submitting a feature request by `creating a new issue on our GitHub issue tracker <https://github.com/biocore/qiime/issues>`_ and labelling it as an *enhancement*. You will need to create a free GitHub account in order to create an issue. |
15 | | - |
16 | | -A standard QIIME analysis begins with sequence data from one or more sequencing platforms, including Sanger, Roche/454, and Illumina GAIIx. QIIME can perform library de-multiplexing and quality filtering; denoising with AmpliconNoise or the QIIME Denoiser; OTU and representative set picking with uclust, cdhit, mothur, BLAST, or other tools; taxonomy assignment with uclust, BLAST, the RDP classifier, mothur, or rtax; sequence alignment with PyNAST, muscle, infernal, or other tools; phylogeny reconstruction with FastTree, raxml, clearcut, or other tools; alpha diversity and rarefaction, including visualization of results, using over 20 metrics including Phylogenetic Diversity, chao1, and observed species; beta diversity and rarefaction, including visualization of results, using over 25 metrics including weighted and unweighted UniFrac, Euclidean distance, and Bray-Curtis; summarization and visualization of taxonomic composition of samples using area, bar and pie charts along with distance histograms; and many other features. While QIIME is primarily used for analysis of amplicon data, many of the downstream analysis pipeline (such as alpha rarefaction and jackknifed beta diversity) can be performed on any type of `sample x observation tables if they are formatted correctly <./documentation/file_formats.html#otu-table-format>`_. |
17 | | - |
18 | | -QIIME includes parallelization capabilities for many of the computationally intensive steps. By default, these are configured to utilize a mutli-core environment, and are easily configured to run in a cluster environment. QIIME is built in Python using the open-source PyCogent_ toolkit. It makes extensive use of unit tests, and is highly modular to facilitate custom analyses. |
19 | | - |
20 | | -Blog and Mailing List |
21 | | -===================== |
22 | | -We recommend that all QIIME users keep an eye on the QIIME blog for important announcements. You can `subscribe to the RSS feed <http://qiime.wordpress.com/feed/>`_ or `sign up for e-mail notifications on the front page of the blog <http://qiime.wordpress.com>`_. This is a very low traffic list (typically around one message per month), and we will not share subscriber information with anyone. |
23 | | - |
24 | | -Downloading and installing QIIME |
25 | | -================================ |
26 | | - |
27 | | -There are several ways to get a working install of QIIME. |
28 | | - |
29 | | -The easiest is to use our virtual machines: |
30 | | - |
31 | | - * Virtual Box: The QIIME Virtual Box is an Ubuntu Linux virtual machine, pre-loaded with QIIME and its dependencies. This is the quickest way to start using QIIME. To get the Virtual Box, please `see Virtual Box documentation <./install/virtual_box.html>`_. |
32 | | - |
33 | | - * Amazon EC2 image: A QIIME EC2 image can be loaded in the Amazon Web Services cloud. For details, `see EC2 documentation <./install/vm_ec2.html>`_. |
34 | | - |
35 | | -Alternatively, there are a few choices for automated installation of QIIME. |
36 | | - |
37 | | - * qiime-deploy: The `qiime-deploy <https://github.com/qiime/qiime-deploy>`_ tool can be used to easily install various versions of QIIME natively on Linux systems. |
38 | | - * MacQIIME: `MacQIIME <http://www.wernerlab.org/software/macqiime>`_ includes a nearly-full installation of QIIME for Mac OS X users. |
39 | | - |
40 | | -If you are instead interested in a native install of QIIME, you can choose between the QIIME base install, which provides access to the most commonly used features of QIIME (with default parameters), or the QIIME full install. For both, you should begin with the `QIIME installation guide <./install/install.html>`_. For most users, the QIIME base install will be sufficient, at least when getting started. |
41 | | - |
42 | | -If installing QIIME natively, you'll need to choose between the release and development version of QIIME. |
43 | | - |
44 | | - * Stable Release: Currently the most stable version of QIIME is our |release| release, which you can `download here <https://pypi.python.org/pypi/qiime>`_. If you don't know whether you want to install the release or development version of QIIME, you most likely want the release version. |
45 | | - |
46 | | - * Development Version: QIIME is under very active development. To get the latest development version of QIIME, you access our git repository, which is hosted on GitHub. While this code is subject to minor changes in interface, it will provide access to the latest and greatest features. The official web documentation is likely to be out-of-date with respect to the development software. You should instead refer to the documentation in Qiime/doc. Check out the latest version of QIIME using git with the command:: |
47 | | - |
48 | | - git clone git://github.com/biocore/qiime.git Qiime |
49 | | - |
50 | | - |
51 | | -Learning QIIME |
52 | | -========================== |
53 | | -After installing QIIME, you should move on to the `QIIME Illumina Overview Tutorial <./tutorials/illumina_overview_tutorial.html>`_ to analyze an example data set. As you begin using QIIME on your own data, you'll want to refer to the `QIIME tutorials <./tutorials/index.html>`_ and the `QIIME documentation <./documentation/index.html>`_. |
54 | | - |
55 | | -Contact Us |
56 | | -========== |
57 | | -To get help with using QIIME, please visit http://help.qiime.org. |
58 | | - |
59 | | -Users can also submit bug reports and feature requests via our `GitHub issue tracker <https://github.com/biocore/qiime/issues>`_. |
60 | | - |
61 | | -QIIME Development |
62 | | -================= |
63 | | - |
64 | | -QIIME is an open-source project, primarily developed in the `Knight Lab <http://www.knightlab.ucsd.edu>`_ at the University of Colorado at Boulder, the `Caporaso Lab <http://caporasolab.us>`_ at Northern Arizona University and the `Clemente Lab <http://clemente-lab.github.io>`_ at Icahn School of Medicine at Mount Sinai. If you are interested in getting involved, check out the `developer notes <./developer/index.html>`_. |
65 | | - |
66 | | -Citing QIIME |
67 | | -============ |
68 | | -If you use QIIME for any published research, please include the following citation: |
69 | | - |
70 | | - **QIIME allows analysis of high-throughput community sequencing data** |
71 | | - |
72 | | - J Gregory Caporaso, Justin Kuczynski, Jesse Stombaugh, Kyle Bittinger, Frederic D Bushman, Elizabeth K Costello, Noah Fierer, Antonio Gonzalez Pena, Julia K Goodrich, Jeffrey I Gordon, Gavin A Huttley, Scott T Kelley, Dan Knights, Jeremy E Koenig, Ruth E Ley, Catherine A Lozupone, Daniel McDonald, Brian D Muegge, Meg Pirrung, Jens Reeder, Joel R Sevinsky, Peter J Turnbaugh, William A Walters, Jeremy Widmann, Tanya Yatsunenko, Jesse Zaneveld and Rob Knight; Nature Methods, 2010; doi:10.1038/nmeth.f.303 |
73 | 4 |
|
| 5 | +This is the main entry point into the QIIME documentation. If you're looking for information about QIIME, you should start on the `QIIME homepage <http://www.qiime.org>`_. |
74 | 6 |
|
75 | | -You can find the `QIIME paper here <http://www.nature.com/nmeth/journal/v7/n5/full/nmeth.f.303.html>`_, and the data presented in this paper can be found `here <ftp://ftp.microbio.me/qiime/QIIME_NM_2010.tgz>`_. |
| 7 | +.. toctree:: |
| 8 | + :maxdepth: 1 |
| 9 | + :glob: |
76 | 10 |
|
77 | | -.. _PyCogent: http://www.pycogent.org |
| 11 | + install/index |
| 12 | + tutorials/index |
| 13 | + scripts/index |
| 14 | + documentation/index |
| 15 | + developer/index |
0 commit comments