Skip to content

Commit 66a432b

Browse files
authored
Merge pull request #348 from nf-core/jfy133-docs-patch
Update usage.md
2 parents ba0139d + fb577aa commit 66a432b

1 file changed

Lines changed: 13 additions & 7 deletions

File tree

docs/usage.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -186,32 +186,38 @@ If left unspecified, a default pattern is used: `data/*{1,2}.fastq.gz`
186186

187187
#### `--single_end`
188188

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:
190192

191193
```bash
192-
--single_end --reads 'path/to/data/*.fastq'
194+
--single_end --reads 'path/to/data/*.fastq.gz'
193195
```
194196

195197
for a single sample, or
196198

197199
```bash
198-
--single_end --reads 'path/to/data/*/*.fastq'
200+
--single_end --reads 'path/to/data/*/*.fastq.gz'
199201
```
200202

201203
for multiple samples, where each sample's FASTQs are in it's own directory (indicated by the first `*`)
202204

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.
204206

205207
#### `--paired_end`
206208

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.
208210

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:
210214

211215
```bash
212-
--paired_end --reads '*.fastq'
216+
--paired_end --reads '*_R{1,2}_*.fastq.gz'
213217
```
214218

219+
**Important**: You must always supply a read-grouping with the `{1,2}` system for each sample when using the `--paired_end` flag.
220+
215221
#### `--bam`
216222

217223
Specifies the input file type to `--reads` is in BAM format. This is only valid in combination with `--single_end`.

0 commit comments

Comments
 (0)