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.

3 changes: 0 additions & 3 deletions .github/workflows/awstest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ name: nf-core AWS test
# It runs the -profile 'test' on AWS batch.

on:
push:
branches:
- master
workflow_dispatch:

jobs:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ jobs:

- name: Build new docker image
if: env.GIT_DIFF
run: docker build --no-cache . -t nfcore/eager:2.2.0
run: docker build --no-cache . -t nfcore/eager:2.2.1

- name: Pull docker image
if: ${{ !env.GIT_DIFF }}
run: |
docker pull nfcore/eager:dev
docker tag nfcore/eager:dev nfcore/eager:2.2.0
docker tag nfcore/eager:dev nfcore/eager:2.2.1

- name: Install Nextflow
run: |
Expand Down
365 changes: 188 additions & 177 deletions CHANGELOG.md

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM nfcore/base:1.10.2
FROM nfcore/base:1.11
LABEL authors="The nf-core/eager community" \
description="Docker image containing all software requirements for the nf-core/eager pipeline"

Expand All @@ -7,10 +7,10 @@ COPY environment.yml /
RUN conda env create --quiet -f /environment.yml && conda clean -a

# Add conda installation dir to PATH (instead of doing 'conda activate')
ENV PATH /opt/conda/envs/nf-core-eager-2.2.0/bin:$PATH
ENV PATH /opt/conda/envs/nf-core-eager-2.2.1/bin:$PATH

# Dump the details of the installed packages to a file for posterity
RUN conda env export --name nf-core-eager-2.2.0 > nf-core-eager-2.2.0.yml
RUN conda env export --name nf-core-eager-2.2.1 > nf-core-eager-2.2.1.yml

# Instruct R processes to use these empty files instead of clashing with a local version
RUN touch .Rprofile
Expand Down
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 @@ -60,6 +60,8 @@

<!-- /TOC -->

## Introduction

## Running the pipeline

### Quick Start
Expand Down Expand Up @@ -735,6 +737,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 @@ -756,6 +762,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 @@ -789,6 +799,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 @@ -2382,7 +2396,7 @@ profiles {
big_data {
process {
withName: markduplicates {
memory = { check_max( 16.GB * task.attempt, 'memory' ) }
memory = 16.GB
}
}
}
Expand All @@ -2393,6 +2407,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)

Comment on lines +2410 to +2415
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could point to the old version of the file, to show that more clearly.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean old version?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To point to a version where you have this still in or to something similar.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see - good point. I don't think it'll be removed for a long time as it's in the nf-core template and AFAIK it would still be valid for DSL2. But I'll note that for the next patch (had to release today because I'm running a workshop tomorrow and needed to make sure it's working 😅 )

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

```bash
Expand Down
2 changes: 1 addition & 1 deletion environment.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: nf-core-eager-2.2.0
name: nf-core-eager-2.2.1
channels:
- conda-forge
- bioconda
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
4 changes: 2 additions & 2 deletions nextflow.config
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ params {

// Container slug. Stable releases should specify release tag!
// Developmental code should specify :dev
process.container = 'nfcore/eager:2.2.0'
process.container = 'nfcore/eager:2.2.1'

// Load base.config by default for all pipelines
includeConfig 'conf/base.config'
Expand Down Expand Up @@ -345,7 +345,7 @@ manifest {
description = 'A fully reproducible and state-of-the-art ancient DNA analysis pipeline'
mainScript = 'main.nf'
nextflowVersion = '!>=20.04.0'
version = '2.2.0'
version = '2.2.1'
}

// Function to ensure that resource requirements don't go beyond
Expand Down
Loading