Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions .dockstore.yml

This file was deleted.

371 changes: 190 additions & 181 deletions CHANGELOG.md

Large diffs are not rendered by default.

Binary file modified docs/images/usage/merging_files.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
85 changes: 58 additions & 27 deletions docs/images/usage/merging_files.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 21 additions & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@

<!-- /TOC -->

## Introduction

## Running the pipeline

### Quick Start
Expand Down Expand Up @@ -747,6 +749,10 @@ If you want to use pre-existing `bwa index` indices, please supply the
nf-core/eager will automagically detect the index files by searching for the
FASTA filename with the corresponding `bwa` index file suffixes.

> :warning: pre-built indices must currently be built on non-gzipped FASTA files
> due to limitations of `samtools`. However once indices have been built, you
> can re-gzip the FASTA file as nf-core will unzip this particular file for you.

For example:

```bash
Expand All @@ -768,6 +774,10 @@ If you want to use pre-existing `bt2 index` indices, please supply the
nf-core/eager will automagically detect the index files by searching for the
FASTA filename with the corresponding `bt2` index file suffixes.

> :warning: pre-built indices must currently be built on non-gzipped FASTA files
> due to limitations of `samtools`. However once indices have been built, you
> can re-gzip the FASTA file as nf-core will unzip this particular file for you.

For example:

```bash
Expand Down Expand Up @@ -801,6 +811,10 @@ If you want to use a pre-existing `picard CreateSequenceDictionary` dictionary
file, use this to specify the required `.dict` file for the selected reference
genome.

> :warning: pre-built indices must currently be built on non-gzipped FASTA files
> due to limitations of `samtools`. However once indices have been built, you
> can re-gzip the FASTA file as nf-core will unzip this particular file for you.

For example:

```bash
Expand Down Expand Up @@ -2394,7 +2408,7 @@ profiles {
big_data {
process {
withName: markduplicates {
memory = { check_max( 16.GB * task.attempt, 'memory' ) }
memory = 16.GB
}
}
}
Expand All @@ -2405,6 +2419,12 @@ Where we have increased the default `4.GB` to `16.GB`. Make sure that you keep
the `check_max` function, as this prevents your run asking for too much memory
during retries.

> Note that with this you will _not_ have the automatic retry mechanism. If
> you want this, re-add the `check_max()` function on the `memory` line, and
> add to the bottom of the entire file (outside the profiles block), the
> block starting `def check_max(obj, type) {`, which is at the end of the
> [nextflow.config file](https://github.com/nf-core/eager/blob/master/nextflow.config)

Once saved, we can then modify your original Nextflow run command:

```bash
Expand Down
2 changes: 2 additions & 0 deletions main.nf
Original file line number Diff line number Diff line change
Expand Up @@ -348,6 +348,7 @@ if( params.bt2_index != '' && params.mapper == 'bowtie2' ){
.into {bt2_index; bt2_index_bwamem}

bwa_index = Channel.empty()
bwa_index_bwamem = Channel.empty()
}

// Validate BAM input isn't set to paired_end
Expand Down Expand Up @@ -855,6 +856,7 @@ if( params.bwa_index == '' && !params.fasta.isEmpty() && (params.mapper == 'bwaa
mkdir BWAIndex && mv ${fasta}* BWAIndex
"""
}

bt2_index = Channel.empty()
}

Expand Down
2 changes: 1 addition & 1 deletion nextflow_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -399,7 +399,7 @@
"help_text": "Turns off QualiMap and thus does not compute coverage and other mapping metrics.\n"
}
},
"fa_icon": "fas fa-forward",
"fa_icon": "fas fa-fast-forward",
"help_text": "Some of the steps in the pipeline can be executed optionally. If you specify\nspecific steps to be skipped, there won't be any output related to these\nmodules."
},
"complexity_filtering": {
Expand Down