Skip to content

Commit faa011a

Browse files
committed
addressing @ackermag and @ElDeveloper comments
1 parent 6a0ff1c commit faa011a

File tree

7 files changed

+35
-25
lines changed

7 files changed

+35
-25
lines changed

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Accepted raw files
5252
* Multiplexed SFF
5353
* Multiplexed FASTQ: forward, reverse (optional), and barcodes
5454
* Per sample FASTQ: forward
55-
* Multiplexed fasta/qual files.
55+
* Multiplexed FASTA/qual files
5656

5757
Known issues
5858
------------
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
.navbar-brand > img {
22
display: inline-block;
33
}
4+
5+
.red {
6+
color:red;
7+
}

qiita_pet/support_files/doc/source/faq.rst

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,14 @@ What kind of data can I upload to Qiita for processing?
66

77
Processing in Qiita requires 3 things: raw data, sample and prep information
88
files. `Here <https://github.com/biocore/qiita/blob/master/README.rst#accepted-raw-files>__`
9-
a list of currently supported raw files files. Note that we are accepting
10-
any kind of target gene (16S, 18S, ITS, whatever) as long as there is
11-
some kind of demultiplexing strategy. You can also upload WGS however, WGS
12-
processing is not ready.
9+
you can find a list of currently supported raw files files. Note that we are
10+
accepting any kind of target gene (16S, 18S, ITS, whatever). You can also upload
11+
WGS however, WGS processing is not ready.
1312

1413
What's the difference between a sample and a prep information file?
1514
-------------------------------------------------------------------
1615

17-
Sample information file is the information about the samples, including
16+
A sample information file describes the samples in a study, including
1817
environmental factors relating to the associated host. The prep information
1918
file has information on how the sample was processed in the wet lab. If you
2019
collected 100 samples for your study, you will need 100 rows in your sample
@@ -32,33 +31,35 @@ Example study processing workflow
3231

3332
A few more instructions: for the example above the workflow should be:
3433

35-
#. Create a new study
36-
#. Add a sample information file, you can add 1, try to process it and the
34+
#. **Create a new study.**
35+
#. **Add a sample information file.** You can add 1, try to process it and the
3736
system will let you know if you have errors or missing columns. The
3837
most common errors are: the sample name column should be named
3938
sample\_name, duplicated sample names are not permitted. For a full list of
4039
required fields, visit :doc:`tutorials/prepare-information-files`.
41-
#. Add a prep information file to your study for each data type. The prep
40+
#. **Add a prep information file to your study for each data type.** The prep
4241
information file should contain all the samples in the sample information
4342
file or a subset. If you have more than one FASTQ file set (forward,
44-
reverse (optional) and barcodes) you will need to add a run_prefix
45-
column. A prep information file and a QIIME compatible mapping file will
43+
reverse (optional) and barcodes) you will need to add a
44+
:ref:`run_prefix <required-fields-for-preprocessing-target-gene-data>`
45+
column.
46+
A prep information file and a QIIME compatible mapping file will
4647
be available for download after the prep information file is added
4748
successfully.
48-
#. Upload and link your raw data to each of your prep information files.
49+
#. **Upload and link your raw data to each of your prep information files.**
4950
Depending on your barcoding/sequencing strategy you might need 1 or more
50-
raw datas file sets. If you have 2 raw data sets you may have to rename one
51+
raw data file sets. If you have 2 raw data sets you may have to rename one
5152
set so that each set has a different name. If they have the same name they
5253
will over-write on upload. Note that you can have one FASTQ file set linked
5354
to more than one prep information file.
54-
#. Preprocess your files. For target gene amplicon sequencing, this will demux
55+
#. **Preprocess your files.** For target gene amplicon sequencing, this will demux
5556
and QC. There are multiple options for preprocessing depending on the
5657
barcode format and the data output from the sequencing center - this may
5758
require a series of trial and error to establish the correct option for
5859
your data files. After demultiplexing a log file is generated with
5960
statistics about the files demultiplexed including the number of sequences
6061
assigned per sample.
61-
#. Process each of your preprocessed data types. For target gene, this will
62-
perform close OTU picking against the latest version of Greengenes and can
62+
#. **Process each of your preprocessed data types.** For target gene, this will
63+
perform closed OTU picking against the latest version of Greengenes and can
6364
be quite time consuming depending on the number of samples and the depth
6465
of sequencing.

qiita_pet/support_files/doc/source/qiita-philosophy/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ environments for each pipeline gives the freedom of adding any pipeline with
1313
any software dependencies to Qiita. Artifacts, basically any file in the
1414
system, from raw sequence to contingency tables or even data visualizations,
1515
permits the system to store any kind of data but also define within each
16-
pipelines which commands and parameter can applied to them.
16+
pipelines which commands and parameters can applied to them.
1717

1818
The current plugins available are:
1919

qiita_pet/support_files/doc/source/tutorials/ebi-submission.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
.. index:: ebi-submission
44

5+
.. role:: red
6+
57
EBI submission via Qiita
68
========================
79

@@ -19,10 +21,11 @@ help send an email to `qiita.help@gmail.com <qiita.help@gmail.com>`__. Help will
1921
advice on additional fields to add to ensure MiXs compliance.
2022

2123
Note that submissions are time consuming and need full collaboration from the user.
22-
Do not wait until the last minute to request help. In general, the best time to request a submission
23-
is when you are writing your paper. Remember that the data can be submitted to EBI and can be
24-
kept private and simply make public when the paper is accepted. Note that EBI/ENA takes up to 15 days to
25-
change the status from private to public, so consider this when submitting data and your manuscript.
24+
:red:`Do not wait until the last minute to request help.` In general, the best
25+
time to request a submission is when you are writing your paper. Remember that the
26+
data can be submitted to EBI and can be kept private and simply make public when
27+
the paper is accepted. Note that EBI/ENA takes up to 15 days to change the status
28+
from private to public, so consider this when submitting data and your manuscript.
2629

2730
.. note::
2831
For convenience Qiita allows you to upload a QIIME mapping file to process your data. However,

qiita_pet/support_files/doc/source/tutorials/no-raw-sequences.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ named ``forward`` and all of our reverse reads are in a folder named
5757
cat forward/*.fastq > forward.fastq
5858
cat reverse/*.fastq > reverse.fastq
5959
60-
While there is no requirement to comprass the generated files, it makes data
60+
While there is no requirement to compress the generated files, it makes data
6161
transfer and storage more convenient. The preferred and only supported
6262
compression program to use is ``gzip``:
6363

qiita_pet/support_files/doc/source/tutorials/prepare-information-files.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ the centralized `Qiita server <http://qiita.microbio.me>`__:
6464
+-----------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
6565
| ``physical_specimen_remaining`` | ``TRUE`` or ``FALSE`` | Is there still physical sample (e.g., soil, not DNA) available? |
6666
+-----------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
67-
| ``dna_extracted`` | ``y`` or ``n`` | Has DNA already been extracted for this sample? |
67+
| ``dna_extracted`` | ``TRUE`` or ``FALSE`` | Has DNA already been extracted for this sample? |
6868
+-----------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
6969
| ``latitude`` | `decimal degrees <http://en.wikipedia.org/wiki/Decimal_degrees>`__ | Latitude where sample was collected. |
7070
+-----------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -108,7 +108,7 @@ system:
108108
Required fields for EBI submission
109109
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
110110

111-
These are the columns required for successfully submit your data to EBI:
111+
Without this columns you will not be able to submit to EBI. These are the columns required for successfully submit your data to EBI:
112112

113113
+-------------------------------------+-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
114114
| Field name | Format | Description |
@@ -117,7 +117,7 @@ These are the columns required for successfully submit your data to EBI:
117117
+-------------------------------------+-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
118118
| ``center_name`` | free text | Name of the sequencing facility. |
119119
+-------------------------------------+-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
120-
| ``platform`` | ``Illumina`` or ``LS454`` | The sequencing technology used in the study. ``Illumina`` sequencing data was generated on an Illumina platform; ``LS454`` sequencing data was generated on a 454 pyrosequencing. |
120+
| ``platform`` | ``Illumina`` or ``LS454`` | The sequencing technology used in the study. ``Illumina`` sequencing data was generated on an Illumina platform; ``LS454`` sequencing data was generated on a 454 pyrosequencing platform. |
121121
+-------------------------------------+-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
122122
| ``instrument_model`` | see table below | The sequencing instrument model used for sequencing. See table below for valid options. |
123123
+-------------------------------------+-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -136,6 +136,8 @@ Valid values for instrument_model per platform, taken from ftp://ftp.sra.ebi.ac.
136136
| ``Illumina`` | ``Illumina Genome Analyzer``, ``Illumina Genome Analyzer II``, ``Illumina Genome Analyzer Ix``, ``Illumina HiSeq 2500``, ``Illumina HiSeq 2000``, ``Illumina HiSeq 1500``, ``Illumina HiSeq 1000``, ``Illumina MiSeq``, ``Illumina HiScanSQ``, ``HiSeq X Ten``, ``NextSeq 500``, ``unspecified`` |
137137
+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
138138

139+
.. _required-fields-for-preprocessing-target-gene-data:
140+
139141
Required fields for pre-processing target gene data
140142
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
141143

0 commit comments

Comments
 (0)