You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/usage.md
+13-7Lines changed: 13 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -186,32 +186,38 @@ If left unspecified, a default pattern is used: `data/*{1,2}.fastq.gz`
186
186
187
187
#### `--single_end`
188
188
189
-
If you have single-end data or BAM files, you need to specify `--single_end` on the command line when you launch the pipeline. A normal glob pattern, enclosed in quotation marks, can then be used for `--reads`. For example:
189
+
If you have single-end data or BAM files, you need to specify `--single_end` on the command line when you launch the pipeline. A normal glob pattern, enclosed in quotation marks, can then be used for `--reads`.
190
+
191
+
For example:
190
192
191
193
```bash
192
-
--single_end --reads 'path/to/data/*.fastq'
194
+
--single_end --reads 'path/to/data/*.fastq.gz'
193
195
```
194
196
195
197
for a single sample, or
196
198
197
199
```bash
198
-
--single_end --reads 'path/to/data/*/*.fastq'
200
+
--single_end --reads 'path/to/data/*/*.fastq.gz'
199
201
```
200
202
201
203
for multiple samples, where each sample's FASTQs are in it's own directory (indicated by the first `*`)
202
204
203
-
**Note**: It is not possible to run a mixture of single-end and paired-end files in one run.
205
+
**Note**: It is currently not possible to run a mixture of single-end and paired-end files in one run.
204
206
205
207
#### `--paired_end`
206
208
207
-
If you have paired-end data, you need to specify `--paired_end` on the command line when you launc hthe pipeline.
209
+
If you have paired-end data, you need to specify `--paired_end` on the command line when you launch the pipeline.
208
210
209
-
A normal glob pattern, enclosed in quotation marks, can then be used for `--reads`. For example:
211
+
A normal glob pattern, enclosed in quotation marks, can then be used for `--reads`.
212
+
213
+
For example:
210
214
211
215
```bash
212
-
--paired_end --reads '*.fastq'
216
+
--paired_end --reads '*_R{1,2}_*.fastq.gz'
213
217
```
214
218
219
+
**Important**: You must always supply a read-grouping with the `{1,2}` system for each sample when using the `--paired_end` flag.
220
+
215
221
#### `--bam`
216
222
217
223
Specifies the input file type to `--reads` is in BAM format. This is only valid in combination with `--single_end`.
0 commit comments