Skip to content

Commit 178b23a

Browse files
Merge branch 'dev' into master
2 parents 069267a + 3e470f5 commit 178b23a

11 files changed

Lines changed: 234 additions & 154 deletions

File tree

.github/workflows/ci.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
strategy:
2121
matrix:
2222
# Nextflow versions: check pipeline minimum and current latest
23-
nxf_ver: ['20.04.0', '']
23+
nxf_ver: ['20.07.1', '']
2424
steps:
2525
- name: Check out pipeline code
2626
uses: actions/checkout@v2
@@ -34,13 +34,13 @@ jobs:
3434
3535
- name: Build new docker image
3636
if: env.MATCHED_FILES
37-
run: docker build --no-cache . -t nfcore/eager:2.3.1
37+
run: docker build --no-cache . -t nfcore/eager:dev
3838

3939
- name: Pull docker image
4040
if: ${{ !env.MATCHED_FILES }}
4141
run: |
4242
docker pull nfcore/eager:dev
43-
docker tag nfcore/eager:dev nfcore/eager:2.3.1
43+
docker tag nfcore/eager:dev nfcore/eager:dev
4444
4545
- name: Install Nextflow
4646
env:

CHANGELOG.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
1010
### `Fixed`
1111

1212
- [#690](https://github.com/nf-core/eager/pull/690) - Fixed ANGSD output mode for beagle by setting `-doMajorMinor 1` as default in that case
13-
- [#666](https://github.com/nf-core/eager/issues/666) - Fixed input file staging for `print_nuclear_contamination`
14-
- [#631](https://github.com/nf-core/eager/issues/631) - Update minimum Nextflow version to 20.07.1, due to unfortunate bug in Nextflow 20.04.1 causing eager to crash if patch pulled
15-
- Made MultiQC crash behaviour stricter when dealing with large datasets, as reported by @ashildv
16-
- [#652](https://github.com/nf-core/eager/issues/652) Added note to documentation that when using `--skip_collapse` this will use _paired-end_ alignment mode with mappers when using PE data
17-
- [#626](https://github.com/nf-core/eager/issues/626) - Add additional checks to ensure pipeline will give useful error if cells of a TSV column are empty
18-
- Added note to documentation that when using `--skip_collapse` this will use _paired-end_ alignment mode with mappers when using PE data. `
19-
- [#673](https://github.com/nf-core/eager/pull/673) Fix Kraken database loading when loading from directory instead of compressed file.
20-
- [#688](https://github.com/nf-core/eager/issues/668) - Allow pipeline to complete, even if Qualimap crashes due to an empty or corrupt BAM file for one sample/library
21-
- [#683](https://github.com/nf-core/eager/pull/683) - Sets `--igenomes_ignore` to true by default, as rarely used by users currently and makes resolving configs less complex.
22-
- Added exit code `140` to re-tryable exit code list to account for certain scheduler wall-time limit fails.
23-
- [672](https://github.com/nf-core/eager/issues/672) - Removed java parameter from picard tools which could cause memory issues
24-
- [679](https://github.com/nf-core/eager/issues/679) - Refactor within-process bash conditions to groovy/nextflow, due to incompatibility with some servers environments
2513

2614
### `Dependencies`
2715

Dockerfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ COPY environment.yml /
77
RUN conda env create --quiet -f /environment.yml && conda clean -a
88

99
# Add conda installation dir to PATH (instead of doing 'conda activate')
10-
ENV PATH /opt/conda/envs/nf-core-eager-2.3.1/bin:$PATH
10+
ENV PATH /opt/conda/envs/nf-core-eager-2.3.2dev/bin:$PATH
1111

1212
# Dump the details of the installed packages to a file for posterity
13-
RUN conda env export --name nf-core-eager-2.3.1 > nf-core-eager-2.3.1.yml
13+
RUN conda env export --name nf-core-eager-2.3.2dev > nf-core-eager-2.3.2dev.yml
1414

1515
# Instruct R processes to use these empty files instead of clashing with a local version
1616
RUN touch .Rprofile

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# ![nf-core/eager](docs/images/nf-core-eager_logo.png)
1+
# ![nf-core/eager](docs/images/nf-core_eager_logo.png)
22

33
**A fully reproducible and state-of-the-art ancient DNA analysis pipeline**.
44

55
[![GitHub Actions CI Status](https://github.com/nf-core/eager/workflows/nf-core%20CI/badge.svg)](https://github.com/nf-core/eager/actions)
66
[![GitHub Actions Linting Status](https://github.com/nf-core/eager/workflows/nf-core%20linting/badge.svg)](https://github.com/nf-core/eager/actions)
7-
[![Nextflow](https://img.shields.io/badge/nextflow-%E2%89%A520.04.0-brightgreen.svg)](https://www.nextflow.io/)
7+
[![Nextflow](https://img.shields.io/badge/nextflow-%E2%89%A520.07.1-brightgreen.svg)](https://www.nextflow.io/)
88
[![nf-core](https://img.shields.io/badge/nf--core-pipeline-brightgreen.svg)](https://nf-co.re/)
99
[![DOI](https://zenodo.org/badge/135918251.svg)](https://zenodo.org/badge/latestdoi/135918251)
1010

@@ -159,6 +159,8 @@ of this pipeline:
159159
Those who have provided conceptual guidance, suggestions, bug reports etc.
160160

161161
* Arielle Munters
162+
* [Charles Plessy](https://github.com/charles-plessy)
163+
* [Åshild Vågene](https://github.com/ashildv)
162164
* [Hester van Schalkwyk](https://github.com/hesterjvs)
163165
* [Ido Bar](https://github.com/IdoBar)
164166
* [Irina Velsko](https://github.com/ivelsko)

conf/base.config

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ process {
1414
memory = { check_max( 7.GB * task.attempt, 'memory' ) }
1515
time = { check_max( 24.h * task.attempt, 'time' ) }
1616

17-
errorStrategy = { task.exitStatus in [143,137,104,134,139] ? 'retry' : 'finish' }
17+
errorStrategy = { task.exitStatus in [143,137,104,134,139, 140] ? 'retry' : 'finish' }
1818
maxRetries = 3
1919
maxErrors = '-1'
2020

@@ -74,38 +74,34 @@ process {
7474
}
7575

7676
withName:qualimap{
77-
errorStrategy = { task.exitStatus in [1,143,137,104,134,139] ? 'retry' : 'finish' }
77+
errorStrategy = { task.exitStatus in [1,143,137,104,134,139, 140] ? 'retry' : task.exitStatus in [255] ? 'ignore' : 'finish' }
7878
}
7979

8080
withName:preseq {
8181
errorStrategy = 'ignore'
8282
}
8383

8484
withName:damageprofiler {
85-
errorStrategy = { task.exitStatus in [1,143,137,104,134,139] ? 'retry' : 'finish' }
85+
errorStrategy = { task.exitStatus in [1,143,137,104,134,139, 140] ? 'retry' : 'finish' }
8686
}
8787

8888
// Add 1 retry for certain java tools as not enough heap space java errors gives exit code 1
8989
withName: dedup {
90-
errorStrategy = { task.exitStatus in [1,143,137,104,134,139] ? 'retry' : 'finish' }
90+
errorStrategy = { task.exitStatus in [1,143,137,104,134,139, 140] ? 'retry' : 'finish' }
9191
}
9292

9393
withName: markduplicates {
94-
errorStrategy = { task.exitStatus in [143,137] ? 'retry' : 'finish' }
94+
errorStrategy = { task.exitStatus in [143,137, 140] ? 'retry' : 'finish' }
9595
}
9696

9797
// Add 1 retry as not enough heapspace java error gives exit code 1
9898
withName: malt {
99-
errorStrategy = { task.exitStatus in [1,143,137,104,134,139] ? 'retry' : 'finish' }
99+
errorStrategy = { task.exitStatus in [1,143,137,104,134,139, 140] ? 'retry' : 'finish' }
100100
}
101101

102102
// other process specific exit statuses
103103
withName: nuclear_contamination {
104-
errorStrategy = { task.exitStatus in [143,137,104,134,139] ? 'ignore' : 'retry' }
105-
}
106-
107-
withName: multiqc {
108-
errorStrategy = { task.exitStatus in [143,137] ? 'retry' : 'ignore' }
104+
errorStrategy = { task.exitStatus in [143,137,104,134,139, 140] ? 'ignore' : 'retry' }
109105
}
110106

111107
}

docs/output.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -551,6 +551,8 @@ Note that many of the statistics from this module are displayed in the General S
551551

552552
You will receive output for each *sample*. This means you will statistics of deduplicated values of all types of libraries combined in a single value (i.e. non-UDG treated, full-UDG, paired-end, single-end all together).
553553

554+
:warning: If your library has no reads mapping to the reference, this will result in an empty BAM file. Qualimap will therefore not produce any output even if a BAM exists!
555+
554556
#### Coverage Histogram
555557

556558
This plot shows on the Y axis the range of fold coverages that the bases of the reference genome are possibly covered by. The Y axis shows the number of bases that were covered at the given fold coverage depth as indicated on the Y axis.

docs/usage.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -413,6 +413,14 @@ they are unique (e.g. if one library was sequenced on Lane 8 of two HiSeq runs,
413413
specify lanes as 8 and 16 for each FASTQ file respectively). For library merging
414414
errors, you must modify your `Library_ID`s accordingly, to make them unique.
415415
416+
### A library or sample is missing in my MultiQC report
417+
418+
In some cases it maybe no output log is produced by a particular tool for MultiQC. Therefore this sample will not be displayed.
419+
420+
Known cases include:
421+
422+
- Qualimap: there will be no MultiQC output if the BAM file is empty. An empty BAM file causes Qualimap to crash - this is crash is ignored by nf-core/eager (to allow the rest of the pipeline to continue) and will therefore have no log file for that particular sample/library
423+
416424
## Tutorials
417425
418426
### Tutorial - How to investigate a failed run

environment.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# You can use this file to create a conda environment for this pipeline:
22
# conda env create -f environment.yml
3-
name: nf-core-eager-2.3.1
3+
name: nf-core-eager-2.3.2dev
44
channels:
55
- conda-forge
66
- bioconda

0 commit comments

Comments
 (0)