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

RC 3.16.0 #1395

Merged
merged 121 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
121 commits
Select commit Hold shift + click to select a range
3e0793f
Install kraken2 and bracken
egreenberg7 Jul 30, 2024
a7281e5
Change nextflow configurations
egreenberg7 Jul 30, 2024
734919e
Initial addition of kraken and bracken to pipeline
egreenberg7 Jul 30, 2024
8695f50
Fix include statements
egreenberg7 Jul 31, 2024
44ba282
Fix include statements
egreenberg7 Jul 31, 2024
3657e3e
Include module config files
egreenberg7 Aug 5, 2024
7ab90f6
Use presence of kraken_db to determine bracken run, add save params
egreenberg7 Aug 5, 2024
39cfdef
Fix multiqc for Bracken/Kraken
egreenberg7 Aug 5, 2024
2e9c243
Add Bracken/Kraken citations
egreenberg7 Aug 5, 2024
03314c9
Fix bracken config
egreenberg7 Aug 6, 2024
7913cbc
Update bracken
egreenberg7 Aug 7, 2024
063b4ac
Adjust multiqc configs for updated bracken
egreenberg7 Aug 7, 2024
075bca8
Add input validation and update scheme
egreenberg7 Aug 7, 2024
a0a225c
Change default Bracken precision to species
egreenberg7 Aug 7, 2024
bd4ea1c
Debug input validation
egreenberg7 Aug 7, 2024
7789827
Documentation/output image
egreenberg7 Aug 7, 2024
336a7b0
Update changelog
egreenberg7 Aug 7, 2024
a1e1d99
Update Kraken2 module
egreenberg7 Aug 9, 2024
33c9483
Linting
egreenberg7 Aug 9, 2024
102152e
Change to --contaminant_screening param
egreenberg7 Aug 15, 2024
6dd7521
Fixing save unaligned default
egreenberg7 Aug 15, 2024
fdd85ad
Debugging
egreenberg7 Aug 15, 2024
c0099d4
Update usage
egreenberg7 Aug 15, 2024
c25aa50
Provide motivation for Kraken2 parameters
egreenberg7 Aug 15, 2024
0063c2d
Fix typo
egreenberg7 Aug 16, 2024
53f46b2
Update metro map
egreenberg7 Aug 16, 2024
2dc5746
Merge branch 'dev' into dev
Shaun-Regenbaum Aug 18, 2024
2a322c4
Update schema
egreenberg7 Aug 19, 2024
75a10f7
Update docs/usage.md
egreenberg7 Aug 19, 2024
cfc8945
Change output directory for kraken2/bracken
egreenberg7 Aug 19, 2024
7b6915c
Update main.nf
pditommaso Sep 6, 2024
41bbfdf
Merge branch 'dev' into pditommaso-patch-1
ewels Sep 6, 2024
69f2d0a
Update Changelog
egreenberg7 Sep 10, 2024
68b9a21
Another changelog fix
egreenberg7 Sep 10, 2024
5d20e28
Update CHANGELOG.md
pinin4fjords Sep 10, 2024
b4332d9
Linting fix
egreenberg7 Sep 10, 2024
eada63d
make snapshot versions pretty
maxulysse Sep 13, 2024
e567889
update CHANGELOG
maxulysse Sep 13, 2024
c652e79
update all snapshots
maxulysse Sep 13, 2024
f1d624e
Merge branch 'dev' into better_snapshots
maxulysse Sep 13, 2024
d145a1b
update half of all snaps
maxulysse Sep 13, 2024
6096641
Merge branch 'dev' into better_snapshots
maxulysse Sep 13, 2024
29af996
more snapshots
maxulysse Sep 13, 2024
caa80e6
update snapshots
maxulysse Sep 13, 2024
03b6501
update snapshots
maxulysse Sep 13, 2024
4dc9fb8
Update CHANGELOG.md
maxulysse Sep 14, 2024
2be93d8
update snapshots
maxulysse Sep 14, 2024
6904250
do not sort output
maxulysse Sep 17, 2024
0ae5f13
Merge branch 'dev' into better_snapshots
maxulysse Sep 17, 2024
96c415d
sort output by PATH
maxulysse Sep 17, 2024
6def003
nf-core pipelines bump-version 3.16.0dev
maxulysse Sep 17, 2024
ca3a646
update snapshots
maxulysse Sep 17, 2024
85b320b
update CHANGELOG
maxulysse Sep 17, 2024
6ea73a6
Update CHANGELOG.md
maxulysse Sep 17, 2024
0b4125d
Merge pull request #1386 from maxulysse/3.16.0dev
maxulysse Sep 17, 2024
fb6c429
Merge branch 'dev' into better_snapshots
maxulysse Sep 17, 2024
17054a4
snapshot more files
maxulysse Sep 17, 2024
5b41e56
snapshot more files
maxulysse Sep 17, 2024
6aee372
feature counts snapshots
maxulysse Sep 18, 2024
4d143b5
typo
maxulysse Sep 18, 2024
a3e0328
more snapshots
maxulysse Sep 18, 2024
4811e91
more snapshots
maxulysse Sep 18, 2024
30d629b
update snapshots
maxulysse Sep 18, 2024
c26abe5
better regex
maxulysse Sep 18, 2024
7906611
fix regex
maxulysse Sep 18, 2024
c561922
better regex
maxulysse Sep 18, 2024
77e9cc1
update snapshot
maxulysse Sep 19, 2024
d979788
code polish
maxulysse Sep 19, 2024
742bfa1
rescue some snaps
maxulysse Sep 19, 2024
c9e8d0f
Apply suggestions from code review
maxulysse Sep 19, 2024
26f3993
tiny refactor part I
maxulysse Sep 19, 2024
e44a03c
tiny refactor part II - IT IS GROOVY WE CAN SUBSTRACT :facepalm:
maxulysse Sep 19, 2024
ed2cf1f
update regexes
maxulysse Sep 19, 2024
9234922
move pipeline regexes in UTILS_PIPELINE
maxulysse Sep 19, 2024
26737a7
simplify regexes
maxulysse Sep 19, 2024
3172eaa
fix regexes
maxulysse Sep 19, 2024
bc193df
Merge conflcits
egreenberg7 Sep 19, 2024
fd9b449
Merge branch 'dev' of github.com:egreenberg7/rnaseq into dev
egreenberg7 Sep 19, 2024
41bcd9c
Update hisat2 patch
egreenberg7 Sep 19, 2024
3e0b3e9
(Hopefully) final linting fix
egreenberg7 Sep 19, 2024
02f65ab
Change PR number
egreenberg7 Sep 19, 2024
da7b999
Merge pull request #1388 from egreenberg7/dev
Shaun-Regenbaum Sep 19, 2024
a6a3107
snapshots all filenames
maxulysse Sep 19, 2024
dc788b4
Merge branch 'dev' into better_snapshots
maxulysse Sep 20, 2024
8550e6d
code polish
maxulysse Sep 20, 2024
5a62a0f
typo
maxulysse Sep 20, 2024
41b44b0
Merge branch 'dev' into pditommaso-patch-1
maxulysse Sep 20, 2024
82c833d
Apply suggestions from code review
maxulysse Sep 20, 2024
f5f055e
update CHANGELOG
maxulysse Sep 20, 2024
fadc4ea
Merge pull request #1376 from nf-core/pditommaso-patch-1
pinin4fjords Sep 20, 2024
577c3ab
update animated metro_map
maxulysse Sep 20, 2024
9bc5d85
Merge branch 'dev' into update_animate_map
maxulysse Sep 20, 2024
e6e85ef
Merge pull request #1389 from maxulysse/update_animate_map
maxulysse Sep 20, 2024
712342a
no snpashots of tasks size for workflow for remove_ribo_rna
maxulysse Sep 20, 2024
134fe31
Merge branch 'dev' into better_snapshots
maxulysse Sep 20, 2024
5bd3d87
snapshot number of sucessful tasks
maxulysse Sep 23, 2024
0df0995
typo
maxulysse Sep 23, 2024
b21e93c
Update tests/featurecounts_group_type.nf.test
maxulysse Sep 23, 2024
8dc2d34
why was this not commited?
maxulysse Sep 23, 2024
f6522c8
patch bedtools/genomecov to use quay.io to solve issue with nf-core d…
maxulysse Sep 30, 2024
5c61ed3
use url for singularity
maxulysse Sep 30, 2024
894a770
use proper url for singularity
maxulysse Sep 30, 2024
fcbfa1b
Merge pull request #1393 from maxulysse/patch_registry
maxulysse Sep 30, 2024
30483c7
prepare RC 3.15.2
maxulysse Sep 30, 2024
1424156
update version in snapshots too
maxulysse Sep 30, 2024
5d79bdc
use nft-utils
maxulysse Oct 1, 2024
07ba1b9
update nftignore
maxulysse Oct 1, 2024
00a87fc
Merge branch 'dev' into better_snapshots
maxulysse Oct 1, 2024
a83ce56
update pipeline versions in snapshot
maxulysse Oct 1, 2024
b80c6c5
update CHANGELOG
maxulysse Oct 1, 2024
7d14c74
update nftignore
maxulysse Oct 1, 2024
2b856b7
update nftignore
maxulysse Oct 1, 2024
1d50d31
3.16.0 instead of 3.15.2
maxulysse Oct 1, 2024
d19cea4
Update CHANGELOG.md
maxulysse Oct 1, 2024
1d35e2a
use nft-utils 0.0.2 to get relative path in snapshots
maxulysse Oct 2, 2024
07197c5
Merge pull request #1379 from maxulysse/better_snapshots
maxulysse Oct 2, 2024
a5d636a
Merge branch 'dev' into prepare_3.15.2
maxulysse Oct 2, 2024
73c8101
forgot a merge
maxulysse Oct 2, 2024
2867938
Merge pull request #1394 from maxulysse/prepare_3.15.2
maxulysse Oct 2, 2024
f901e4f
Merge branch 'master' into dev
maxulysse Oct 2, 2024
00a0857
Apply suggestions from code review
maxulysse Oct 2, 2024
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
51 changes: 51 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,62 @@
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [[3.16.0](https://github.com/nf-core/rnaseq/releases/tag/3.16.0)] - 2024-10-02

### Credits

Special thanks to the following for their contributions to the release:

- [Adam Talbot](https://github.com/adamrtalbot)
- [Ezra Greenberg](https://github.com/egreenberg7)
- [Jonathan Manning](https://github.com/pinin4fjords)
- [Matthias Zepper](https://github.com/MatthiasZepper)
- [Maxime Garcia](https://github.com/maxulysse)
- [Paolo Di Tommaso](https://github.com/pditommaso)
- [Phil Ewels](https://github.com/ewels)
- [Shaun Regenbaum](https://github.com/Shaun-Regenbaum)

### Enhancements & fixes

- [PR #1376](https://github.com/nf-core/rnaseq/pull/1376) - Fix invalid named parameter syntax
- [PR #1386](https://github.com/nf-core/rnaseq/pull/1386) - Bump pipeline version to 3.16.0dev
- [PR #1388](https://github.com/nf-core/rnaseq/pull/1388) - Adding Kraken2/Bracken on unaligned reads as an additional quality control step to detect sample contamination
- [PR #1389](https://github.com/nf-core/rnaseq/pull/1389) - Update animated subway map
- [PR #1393](https://github.com/nf-core/rnaseq/pull/1393) - Use quay.io for bedtools/genomecov to solve issue with nf-core download

### Parameters

| Old parameter | New parameter |
| ------------- | --------------------------- |
| | `--contaminant_screening` |
| | `--kraken_db` |
| | `--save_kraken_assignments` |
| | `--save_kraken_unassigned` |
| | `--bracken_precision` |

> **NB:** Parameter has been **updated** if both old and new parameter information is present.
> **NB:** Parameter has been **added** if just the new parameter information is present.
> **NB:** Parameter has been **removed** if new parameter information isn't present.

### Software dependencies

| Dependency | Old version | New version |
| ---------- | ----------- | ----------- |
| `Kraken2` | ----------- | 2.1.3 |
| `Bracken` | ----------- | 2.9 |

> **NB:** Dependency has been **updated** if both old and new version information is present.
>
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
>

Copy link
Member Author

Choose a reason for hiding this comment

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

I like the line breaks here

> **NB:** Dependency has been **added** if just the new version information is present.
>
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
>

> **NB:** Dependency has been **removed** if new version information isn't present.

## [[3.15.1](https://github.com/nf-core/rnaseq/releases/tag/3.15.1)] - 2024-09-16

### Enhancements & fixes

- [PR #1374](https://github.com/nf-core/rnaseq/pull/1374) - Bump pipeline version to 3.16.0dev
- [PR #1379](https://github.com/nf-core/rnaseq/pull/1379) - Enhance pipeline level test snapshots
- [PR #1380](https://github.com/nf-core/rnaseq/pull/1380) - Fix issues with R modules changing sample names
- [PR #1381](https://github.com/nf-core/rnaseq/pull/1381) - Update all modules following massive conda usage update in nf-core modules
- [PR #1382](https://github.com/nf-core/rnaseq/pull/1381) - Slight fixes for rnaseq preprocessing
Expand Down
8 changes: 8 additions & 0 deletions CITATIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@

> Quinlan AR, Hall IM. BEDTools: a flexible suite of utilities for comparing genomic features. Bioinformatics. 2010 Mar 15;26(6):841-2. doi: 10.1093/bioinformatics/btq033. Epub 2010 Jan 28. PubMed PMID: 20110278; PubMed Central PMCID: PMC2832824.

- [Bracken](https://doi.org/10.7717/peerj-cs.104)

> Lu, J., Breitwieser, F. P., Thielen, P., & Salzberg, S. L. (2017). Bracken: estimating species abundance in metagenomics data. PeerJ. Computer Science, 3(e104), e104. https://doi.org/10.7717/peerj-cs.104

- [fastp](https://www.ncbi.nlm.nih.gov/pubmed/30423086/)

> Chen S, Zhou Y, Chen Y, Gu J. fastp: an ultra-fast all-in-one FASTQ preprocessor. Bioinformatics. 2018 Sep 1;34(17):i884-i890. doi: 10.1093/bioinformatics/bty560. PubMed PMID: 30423086; PubMed Central PMCID: PMC6129281.
Expand All @@ -38,6 +42,10 @@

> Kim D, Paggi JM, Park C, Bennett C, Salzberg SL. Graph-based genome alignment and genotyping with HISAT2 and HISAT-genotype Graph-based genome alignment and genotyping with HISAT2 and HISAT-genotype. Nat Biotechnol. 2019 Aug;37(8):907-915. doi: 10.1038/s41587-019-0201-4. Epub 2019 Aug 2. PubMed PMID: 31375807.

- [Kraken2](https://doi.org/10.1186/s13059-019-1891-0)

> Wood, D. E., Lu, J., & Langmead, B. (2019). Improved metagenomic analysis with Kraken 2. Genome Biology, 20(1), 257. https://doi.org/10.1186/s13059-019-1891-0

- [MultiQC](https://pubmed.ncbi.nlm.nih.gov/27312411/)

> Ewels P, Magnusson M, Lundin S, Käller M. MultiQC: summarize analysis results for multiple tools and samples in a single report. Bioinformatics. 2016 Oct 1;32(19):3047-8. doi: 10.1093/bioinformatics/btw354. Epub 2016 Jun 16. PubMed PMID: 27312411; PubMed Central PMCID: PMC5039924.
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
3. [`dupRadar`](https://bioconductor.org/packages/release/bioc/html/dupRadar.html)
4. [`Preseq`](http://smithlabresearch.org/software/preseq/)
5. [`DESeq2`](https://bioconductor.org/packages/release/bioc/html/DESeq2.html)
6. [`Kraken2`](https://ccb.jhu.edu/software/kraken2/) -> [`Bracken`](https://ccb.jhu.edu/software/bracken/) on unaligned sequences; _optional_
15. Pseudoalignment and quantification ([`Salmon`](https://combine-lab.github.io/salmon/) or ['Kallisto'](https://pachterlab.github.io/kallisto/); _optional_)
16. Present QC for raw read, alignment, gene biotype, sample similarity, and strand-specificity checks ([`MultiQC`](http://multiqc.info/), [`R`](https://www.r-project.org/))

Expand Down
Binary file added docs/images/bracken-top-n-plot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/nf-core-rnaseq_metro_map_grey.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading