Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release PR for 2.3.5 patch #763

Merged
merged 69 commits into from
Jun 4, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
69 commits
Select commit Hold shift + click to select a range
e48e22a
post release version bump
jfy133 May 5, 2021
0b5c780
Merge branch 'dev' into ver-bump
jfy133 May 5, 2021
4500aae
Merge pull request #740 from jfy133/ver-bump
apeltzer May 6, 2021
9cd8502
Template update for nf-core/tools version 1.14
nf-core-bot May 11, 2021
33970a0
Add light version of logo
jfy133 May 11, 2021
404fd11
Merge pull request #743 from jfy133/extra-logo
jfy133 May 11, 2021
6d84d77
Merge branch 'TEMPLATE' of github.com:nf-core/eager into dev
jfy133 May 12, 2021
6a8325b
Remove space
jfy133 May 12, 2021
53179c7
Merge branch 'dev' into nf-core-template-merge-1.14
jfy133 May 12, 2021
bf01dee
Improve README to state useful for plants and animals as well, and al…
jfy133 May 12, 2021
98d0a80
Updated CHANGELOG
jfy133 May 12, 2021
af37f1c
Add reporting of location of multiqc run report on completeion
jfy133 May 12, 2021
08dc6ab
Add bwa -o parameter as modifying is recommend for aDNA data accordin…
jfy133 May 12, 2021
e8228a2
Improve TSV validation check
jfy133 May 12, 2021
4d05d7e
Replace empty strings with nulls following nf-core best practises
jfy133 May 12, 2021
ff618e0
Update CHANGELOG.md
jfy133 May 12, 2021
62a0c29
Update CHANGELOG.md
jfy133 May 12, 2021
58c0192
Merge pull request #742 from nf-core/nf-core-template-merge-1.14
jfy133 May 12, 2021
1135019
Merge branch 'nf-core:master' into docs-improvement
jfy133 May 12, 2021
f4e0e0e
Merge pull request #13 from nf-core/dev
jfy133 May 14, 2021
0e932d8
Merge pull request #14 from nf-core/dev
jfy133 May 14, 2021
cdeadc2
Merge pull request #745 from jfy133/multiqc-message
jfy133 May 14, 2021
22f0096
Merge pull request #15 from nf-core/dev
jfy133 May 14, 2021
3e571d5
Merge pull request #746 from jfy133/bwa-minuso-flag
jfy133 May 14, 2021
5ad1ef5
Merge pull request #16 from nf-core/dev
jfy133 May 14, 2021
0d87a0c
Update CHANGELOG.md
jfy133 May 14, 2021
6ebf660
Update CHANGELOG.md
jfy133 May 14, 2021
d98d9c7
Merge pull request #747 from jfy133/fix-null-validation
jfy133 May 14, 2021
3509b30
Ninja push for linting reasons
jfy133 May 14, 2021
07943c3
Fix bedtools annotation file condition and re-add defaults
jfy133 May 14, 2021
1c541a1
Merge branch 'dev' into docs-improvement
jfy133 May 14, 2021
9701bcb
Removed sdag profile mentions
TCLamnidis May 14, 2021
6b86a31
fix linting
jfy133 May 14, 2021
02607cc
Merge pull request #17 from TCLamnidis/docs-improvement
jfy133 May 14, 2021
03a6675
Merge pull request #744 from jfy133/docs-improvement
jfy133 May 14, 2021
d8ca43f
Update main.nf
jfy133 May 17, 2021
f613bc7
added missing label mc_small to mtnucratio
alexandregilardet May 18, 2021
63b52e5
Update CHANGELOG.md
jfy133 May 19, 2021
9866346
Merge branch 'dev' into validation-fixes-patch
jfy133 May 19, 2021
9883b85
Update CHANGELOG.md
jfy133 May 19, 2021
505a3e1
updated CHANGELOG and switched mc_small to sc_small
alexandregilardet May 19, 2021
8d409a8
Merge branch 'dev' into master
jfy133 May 19, 2021
e942094
Merge pull request #751 from alexandregilardet/master
jfy133 May 19, 2021
c0342b8
Merge branch 'dev' into validation-fixes-patch
jfy133 May 20, 2021
2828014
Merge pull request #748 from nf-core/validation-fixes-patch
jfy133 May 20, 2021
e15e3fb
Fix piped command CPUs
jfy133 May 21, 2021
da9788d
Obligatory linting fix
jfy133 May 21, 2021
eb2ef30
Update logo for better darkmode support
jfy133 May 21, 2021
64f3972
Update CHANGELOG
jfy133 May 21, 2021
68512b4
All pipeed command processes to multi-threaded and updated bowtie to …
jfy133 May 21, 2021
cf76c02
Remove duplicate samtools
jfy133 May 26, 2021
eeec5d4
remove leftover samtools -h and add missing split_cpus
jfy133 May 26, 2021
8fafdbc
REadd pmdtools view - required apparently
jfy133 May 26, 2021
49956c1
Remove -b flag that @mahesh-panchal correctly pointed out was the pro…
jfy133 May 26, 2021
bd75f9c
Merge pull request #753 from nf-core/cpu-fix
jfy133 May 27, 2021
89e91a2
Remove data type from workflow summary
jfy133 May 28, 2021
932e2a0
Update CHANGELOG.md
jfy133 May 28, 2021
7fc5867
Merge pull request #758 from nf-core/workflow-summary-fix
jfy133 May 28, 2021
fa5945d
New version of logo without banner and without drop
jfy133 May 28, 2021
d6ef725
Software scraping fix
jfy133 May 31, 2021
36407f7
Merge pull request #760 from nf-core/software-version-fix
jfy133 May 31, 2021
2f0a73d
Replace samtools -o with redirect for stability in CI test
jfy133 May 31, 2021
a1c7725
Merge pull request #761 from nf-core/samtools-filter-flakiness-fix
jfy133 Jun 1, 2021
7448b69
Reduce border
jfy133 Jun 2, 2021
bcb5bec
smaller outline
jfy133 Jun 2, 2021
9d807d8
Merge pull request #755 from nf-core/new-logo
jfy133 Jun 2, 2021
0124e31
Bump version for patch release
jfy133 Jun 2, 2021
7205063
Merge pull request #762 from nf-core/ver-buump
jfy133 Jun 2, 2021
b54f41c
Apply suggestions from code review
jfy133 Jun 3, 2021
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
7 changes: 4 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,15 @@ Remember that PRs should be made against the dev branch, unless you're preparing

Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/eager/tree/master/.github/CONTRIBUTING.md)
-->
<!-- markdownlint-disable ul-indent -->

## PR checklist

- [ ] This comment contains a description of changes (with reason).
- [ ] If you've fixed a bug or added code that should be tested, add tests!
- [ ] If you've added a new tool - add to the software_versions process and a regex to `scrape_software_versions.py`
- [ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](https://github.com/nf-core/eager/tree/master/.github/CONTRIBUTING.md)
- [ ] If necessary, also make a PR on the nf-core/eager _branch_ on the [nf-core/test-datasets](https://github.com/nf-core/test-datasets) repository.
- [ ] If you've added a new tool - add to the software_versions process and a regex to `scrape_software_versions.py`
- [ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](<https://github.com/>nf-core/eager/tree/master/.github/CONTRIBUTING.md)
jfy133 marked this conversation as resolved.
Show resolved Hide resolved
- [ ] If necessary, also make a PR on the nf-core/eager _branch_ on the [nf-core/test-datasets](https://github.com/nf-core/test-datasets) repository.
- [ ] Make sure your code lints (`nf-core lint .`).
- [ ] Ensure the test suite passes (`nextflow run . -profile test,docker`).
- [ ] Usage Documentation in `docs/usage.md` is updated.
Expand Down
9 changes: 6 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ on:
release:
types: [published]

# Uncomment if we need an edge release of Nextflow again
# env: NXF_EDGE: 1

jobs:
test:
name: Run workflow tests
Expand All @@ -20,7 +23,7 @@ jobs:
strategy:
matrix:
# Nextflow versions: check pipeline minimum and current latest
nxf_ver: ['20.07.1', '21.03.0-edge']
nxf_ver: ['20.07.1', '']
steps:
- name: Check out pipeline code
uses: actions/checkout@v2
Expand All @@ -34,13 +37,13 @@ jobs:

- name: Build new docker image
if: env.MATCHED_FILES
run: docker build --no-cache . -t nfcore/eager:2.3.4
run: docker build --no-cache . -t nfcore/eager:2.3.5

- name: Pull docker image
if: ${{ !env.MATCHED_FILES }}
run: |
docker pull nfcore/eager:dev
docker tag nfcore/eager:dev nfcore/eager:2.3.4
docker tag nfcore/eager:dev nfcore/eager:2.3.5

- name: Install Nextflow
env:
Expand Down
28 changes: 26 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,40 @@
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## v2.3.5 - 2021-06-03

### `Added`

- [#722](https://github.com/nf-core/eager/issues/722) - Adds bwa `-o` flag for more flexibility in bwa parameters
- [#736](https://github.com/nf-core/eager/issues/736) - Add printing of multiqc run report location on successful completion
- New logo that is more visible when a user is using darkmode on GitHub or nf-core website!

### `Fixed`

- [#723](https://github.com/nf-core/eager/issues/723) - Fixes empty fields in TSV resulting in uninformative error
- Updated template to nf-core/tools 1.14
- [#688](https://github.com/nf-core/eager/issues/688) - Clarified the pipeline is not just for humans and microbes, but also plants and animals, and also for modern DNA
- [#751](https://github.com/nf-core/eager/pull/751) - Added missing label to mtnucratio
- General code cleanup and standardisation of parameters with no default setting
- [#750](https://github.com/nf-core/eager/issues/750) - Fixed piped commands requesting the same number of CPUs at each command step
- [#757](https://github.com/nf-core/eager/issues/757) - Removed confusing 'Data Type' variable from MultiQC workflow summary (not consistent with TSV input)
- [#759](https://github.com/nf-core/eager/pull/759) - Fixed malformed software scraping regex that resulted in N/A in MultiQC report
- [#761](https://github.com/nf-core/eager/pull/759) - Fixed issues related to instability of samtools filtering related CI tests

### `Dependencies`

### `Deprecated`

## v2.3.4 - 2021-05-05

### `Added`

- [#729](https://github.com/nf-core/eager/issues/729) Added Bowtie2 flag `--maxins` for PE mapping modern DNA mapping contexts
- [#729](https://github.com/nf-core/eager/issues/729) - Added Bowtie2 flag `--maxins` for PE mapping modern DNA mapping contexts

### `Fixed`

- Corrected explanation of the "--min_adap_overlap" parameter for AdapterRemoval in the docs
- [#725](https://github.com/nf-core/eager/pull/725) `bwa_index` doc update
- [#725](https://github.com/nf-core/eager/pull/725) - `bwa_index` doc update
- Re-adds gzip piping to AdapterRemovalFixPrefix to speed up process after reports of being very slow
- Updated DamageProfiler citation from bioRxiv to publication

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

Expand All @@ -7,11 +7,7 @@ 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.3.4/bin:$PATH
ENV PATH /opt/conda/envs/nf-core-eager-2.3.5/bin:$PATH

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

# Instruct R processes to use these empty files instead of clashing with a local version
RUN touch .Rprofile
RUN touch .Renviron
RUN conda env export --name nf-core-eager-2.3.5 > nf-core-eager-2.3.5.yml
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![nf-core/eager](docs/images/nf-core_eager_logo.png)
# ![nf-core/eager](docs/images/nf-core_eager_logo_outline_drop.png)

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

Expand All @@ -17,7 +17,7 @@
## Introduction

<!-- nf-core: Write a 1-2 sentence summary of what data the pipeline is for and what it does -->
**nf-core/eager** is a bioinformatics best-practise analysis pipeline for NGS sequencing based ancient DNA (aDNA) data analysis.
**nf-core/eager** is a scalable and reproducible bioinformatics best-practise processing pipeline for genomic NGS sequencing data, with a focus on ancient DNA (aDNA) data. It is ideal for the (palaeo)genomic analysis of humans, animals, plants, microbes and even microbiomes.

The pipeline is built using [Nextflow](https://www.nextflow.io), a workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It comes with docker containers making installation trivial and results highly reproducible. The pipeline pre-processes raw data from FASTQ inputs, or preprocessed BAM inputs. It can align reads and performs extensive general NGS and aDNA specific quality-control on the results. It comes with docker, singularity or conda containers making installation trivial and results highly reproducible.

Expand All @@ -27,7 +27,7 @@ The pipeline is built using [Nextflow](https://www.nextflow.io), a workflow tool

## Quick Start

1. Install [`nextflow`](https://nf-co.re/usage/installation) (version >= 20.04.0)
1. Install [`nextflow`](https://nf-co.re/usage/installation) (`>=20.07.1`)

2. Install any of [`Docker`](https://docs.docker.com/engine/installation/), [`Singularity`](https://www.sylabs.io/guides/3.0/user-guide/), [`Podman`](https://podman.io/), [`Shifter`](https://nersc.gitlab.io/development/shifter/how-to-use/) or [`Charliecloud`](https://hpc.github.io/charliecloud/) for full pipeline reproducibility _(please only use [`Conda`](https://conda.io/miniconda.html) as a last resort; see [docs](https://nf-co.re/usage/configuration#basic-configuration-profiles))_

Expand Down
2 changes: 1 addition & 1 deletion assets/multiqc_config.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
custom_logo: 'nf-core_eager_logo.png'
custom_logo: 'nf-core_eager_logo_outline_drop.png'
custom_logo_url: https://github.com/nf-core/eager/
custom_logo_title: 'nf-core/eager'

Expand Down
4 changes: 2 additions & 2 deletions bin/scrape_software_versions.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
'Bowtie2': ['v_bowtie2.txt', r"bowtie2-([0-9]+\.[0-9]+\.[0-9]+) -fdebug"],
'Qualimap': ['v_qualimap.txt', r"QualiMap v.(\S+)"],
'GATK HaplotypeCaller': ['v_gatk.txt', r" v(\S+)"],
#'GATK UnifiedGenotyper': ['v_gatk3_5.txt', r"version (\S+)"],
'GATK UnifiedGenotyper': ['v_gatk3.txt', r"(\S+)"],
'bamUtil' : ['v_bamutil.txt', r"Version: (\S+);"],
'fastP': ['v_fastp.txt', r"([\d\.]+)"],
'DamageProfiler' : ['v_damageprofiler.txt', r"DamageProfiler v(\S+)"],
Expand All @@ -37,7 +37,7 @@
'kraken':['v_kraken.txt', r"Kraken version (\S+)"],
'eigenstrat_snp_coverage':['v_eigenstrat_snp_coverage.txt',r"(\S+)"],
'mapDamage2':['v_mapdamage.txt',r"(\S+)"],
'bbduk':['v_bbduk.txt',r"(\S+)"]
'bbduk':['v_bbduk.txt',r"(.*)"]
}

results = OrderedDict()
Expand Down
Loading