|
a |
|
b/README.rst |
|
|
1 |
Qiita (canonically pronounced *cheetah*) |
|
|
2 |
======================================== |
|
|
3 |
|
|
|
4 |
|Build Status| |Coverage Status| |
|
|
5 |
|
|
|
6 |
Advances in sequencing, proteomics, transcriptomics, metabolomics, and others are giving |
|
|
7 |
us new insights into the microbial world and dramatically improving our ability |
|
|
8 |
to understand their community composition and function at high resolution. |
|
|
9 |
These new technologies are generating vast amounts of data, even from a single |
|
|
10 |
study or sample, leading to challenges in storage, representation, analysis, |
|
|
11 |
and integration of the disparate data types. Qiita was designed to allow users |
|
|
12 |
address these new challenges by keeping track of multiple studies with multiple |
|
|
13 |
'omics data. Additionally, Qiita is capable of supporting multiple analytical |
|
|
14 |
pipelines through a 3rd-party plugin system, allowing the user to have a single |
|
|
15 |
entry point for all their analyses. Qiita's main site provides database and |
|
|
16 |
compute resources to the global community, alleviating the technical burdens, |
|
|
17 |
such as familiarity with the command line or access to compute power, that are |
|
|
18 |
typically limiting for researchers studying microbial ecology. |
|
|
19 |
|
|
|
20 |
Qiita is currently in production/stable status. We are very open to community |
|
|
21 |
contributions and feedback. If you're interested in contributing to Qiita, |
|
|
22 |
see `CONTRIBUTING.md <https://github.com/qiita-spots/qiita/blob/master/CONTRIBUTING.md>`__. |
|
|
23 |
If you'd like to report bugs or request features, you can do that in the |
|
|
24 |
`Qiita issue tracker <https://github.com/qiita-spots/qiita/issues>`__. |
|
|
25 |
|
|
|
26 |
To install and configure your own Qiita server, see |
|
|
27 |
`INSTALL.md <https://github.com/qiita-spots/qiita/blob/master/INSTALL.md>`__. However, Qiita is not designed to be used locally but rather on a server, we therefore advise against installing your own version on a personal computer. Nevertheless, it can run just fine on a laptop or small computer for development and educational purposes. For example, for every single PR and release, we install Qiita from scratch as GitHub Actions, you can follow `these steps <https://github.com/qiita-spots/qiita/actions>`__. |
|
|
28 |
|
|
|
29 |
For more specific details about Qiita's philosophy and design visit `the Qiita main site tutorial <https://qiita.microbio.me/static/doc/html/qiita-philosophy/index.html>`__. |
|
|
30 |
|
|
|
31 |
Current features |
|
|
32 |
---------------- |
|
|
33 |
|
|
|
34 |
* Full study management: Create, delete, update samples in the sample and |
|
|
35 |
multiple preparation information files. |
|
|
36 |
* Upload files via direct drag & drop from the web interface or via scp |
|
|
37 |
from any server that allows these connections. |
|
|
38 |
* Study privacy management: Sandboxed -> Private -> Public. |
|
|
39 |
* Easy long-term sequence data deposition to the European Nucleotide Archive (ENA), |
|
|
40 |
part of the European Bioinformatics Institute (EBI) for private and public |
|
|
41 |
studies. |
|
|
42 |
* Raw data processing for `Target Gene, Metagenomic, Metabolomic, Genome Isolates and BIOM files <https://qiita.ucsd.edu/static/doc/html/processingdata/index.html#processing-recommendations>`__. NOTE: BIOM files can be added as new preparation files for downstream analyses; however, this cannot be made public in the system. |
|
|
43 |
* Basic downstream analyses using QIIME 2. Note that Qiita produces qza/qzv in the analytical steps but you can also convert `non QIIME 2 artifacts <https://qiita.ucsd.edu/static/doc/html/faq.html#how-to-convert-qiita-files-to-qiime2-artifacts>`__. |
|
|
44 |
* Bulk download of `studies and artifacts <https://qiita.ucsd.edu/static/doc/html/downloading.html>`__. |
|
|
45 |
* Basic study search in the study listing page. |
|
|
46 |
* Complex metadata search via redbiom. |
|
|
47 |
|
|
|
48 |
For more detailed information visit the `Qiita tutorial <https://cmi-workshop.readthedocs.io/en/latest/>`__ |
|
|
49 |
and the `Qiita help <https://qiita.ucsd.edu/static/doc/html/index.html>`__. |
|
|
50 |
|
|
|
51 |
Accepted raw files |
|
|
52 |
------------------ |
|
|
53 |
|
|
|
54 |
* Multiplexed SFF |
|
|
55 |
* Multiplexed FASTQ: forward, reverse (optional), and barcodes |
|
|
56 |
* Per sample FASTQ: forward and reverse (optional) |
|
|
57 |
* Multiplexed FASTA/qual files |
|
|
58 |
* Per sample FASTA, only for "Full Length Operon" |
|
|
59 |
|
|
|
60 |
|
|
|
61 |
.. |Build Status| image:: https://github.com/qiita-spots/qiita/actions/workflows/qiita-ci.yml/badge.svg |
|
|
62 |
:target: https://github.com/qiita-spots/qiita/actions/workflows/qiita-ci.yml |
|
|
63 |
.. |Coverage Status| image:: https://coveralls.io/repos/github/qiita-spots/qiita/badge.svg?branch=dev |
|
|
64 |
:target: https://coveralls.io/github/qiita-spots/qiita?branch=master |