Skip to content

Commit 0a71786

Browse files
committed
fix some heading levels
1 parent e2f7109 commit 0a71786

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

docs/usage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -243,11 +243,11 @@ We recommend adding the following line to your environment to limit this (typica
243243
NXF_OPTS='-Xms1g -Xmx4g'
244244
```
245245

246-
### Input
246+
## Input Specifications
247247

248248
There are two possible ways of supplying input sequencing data to nf-core/eager. The most efficient but more simplistic is supplying direct paths (with wildcards) to your FASTQ or BAM files, with each file or pair being considered a single library and each one run independently. TSV input requires creation of an extra file by the user and extra metadata, but allows more powerful lane and library merging.
249249

250-
#### Direct Input Method
250+
### Direct Input Method
251251

252252
This method is where you specify with `--input`, the path locations of FASTQ (optionally gzipped) or BAM file(s). This option is mutually exclusive to the [TSV input method](#tsv-input-method), which is used for more complex input configurations such as lane and library merging.
253253

@@ -281,7 +281,7 @@ If you have multiple files in different directories, you can use additional wild
281281
6. Due to limitations of downstream tools (e.g. FastQC), sample IDs may be truncated after the first `.` in the name, Ensure file names are unique prior to this!
282282
7. For input BAM files you should provide a small decoy reference genome with pre-made indices, e.g. the human mtDNA or phiX genome, for the mandatory parameter `--fasta` in order to avoid long computational time for generating the index files of the reference genome, even if you do not actually need a reference genome for any downstream analyses.
283283

284-
#### TSV Input Method
284+
### TSV Input Method
285285

286286
Alternatively to the [direct input method](#direct-input-method), you can supply to `--input` a path to a TSV file that contains paths to FASTQ/BAM files and additional metadata. This allows for more complex procedures such as merging of sequencing data across lanes, sequencing runs, sequencing configuration types, and samples.
287287

@@ -357,7 +357,7 @@ Note the following important points and limitations for setting up:
357357
- nf-core/eager functionality such as `--run_trim_bam` will be applied to only non-UDG (UDG_Treatment: none) or half-UDG (UDG_Treatment: half) libraries. - Qualimap is run on each sample, after merging of libraries (i.e. your values will reflect the values of all libraries combined - after being damage trimmed etc.).
358358
- Genotyping will be typically performed on each `sample` independently, as normally all libraries will have been merged together. However, if you have a mixture of single-stranded and double-stranded libraries, you will normally need to genotype separately. In this case you **must** give each the SS and DS libraries _distinct_ `Sample_IDs`; otherwise you will receive a `file collision` error in steps such as `sexdeterrmine`, and then you will need to merge these yourself. We will consider changing this behaviour in the future if there is enough interest.
359359

360-
### Clean up
360+
## Clean up
361361

362362
Once a run has completed, you will have _lots_ of (some very large) intermediate
363363
files in your output directory. These are stored within the directory named

0 commit comments

Comments
 (0)