Skip to content

Commit 14f9d26

Browse files
authored
Merge pull request #1113 from nf-core/dev
Dev -> Master for 3.13.0 release
2 parents 3bec233 + 84a7bb3 commit 14f9d26

File tree

126 files changed

+2824
-2103
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

126 files changed

+2824
-2103
lines changed

.devcontainer/devcontainer.json

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"name": "nfcore",
33
"image": "nfcore/gitpod:latest",
44
"remoteUser": "gitpod",
5+
"runArgs": ["--privileged"],
56

67
// Configure tool-specific properties.
78
"customizations": {

.github/CONTRIBUTING.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ Please use the pre-filled template to save time.
99
However, don't be put off by this template - other more general issues and suggestions are welcome!
1010
Contributions to the code are even more welcome ;)
1111

12-
> If you need help using or modifying nf-core/rnaseq then the best place to ask is on the nf-core Slack [#rnaseq](https://nfcore.slack.com/channels/rnaseq) channel ([join our Slack here](https://nf-co.re/join/slack)).
12+
:::info
13+
If you need help using or modifying nf-core/rnaseq then the best place to ask is on the nf-core Slack [#rnaseq](https://nfcore.slack.com/channels/rnaseq) channel ([join our Slack here](https://nf-co.re/join/slack)).
14+
:::
1315

1416
## Contribution workflow
1517

@@ -116,4 +118,3 @@ To get started:
116118
Devcontainer specs:
117119

118120
- [DevContainer config](.devcontainer/devcontainer.json)
119-
- [Dockerfile](.devcontainer/Dockerfile)

.github/ISSUE_TEMPLATE/bug_report.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ body:
4242
attributes:
4343
label: System information
4444
description: |
45-
* Nextflow version _(eg. 22.10.1)_
45+
* Nextflow version _(eg. 23.04.0)_
4646
* Hardware _(eg. HPC, Desktop, Cloud)_
4747
* Executor _(eg. slurm, local, awsbatch)_
4848
* Container engine: _(e.g. Docker, Singularity, Conda, Podman, Shifter, Charliecloud, or Apptainer)_

.github/workflows/ci.yml

+11-8
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424
strategy:
2525
matrix:
2626
NXF_VER:
27-
- "22.10.1"
27+
- "23.04.0"
2828
- "latest-everything"
2929
steps:
3030
- name: Check out pipeline code
@@ -232,16 +232,19 @@ jobs:
232232
run: |
233233
nextflow run ${GITHUB_WORKSPACE} -profile test_cache,docker --aligner hisat2 ${{ matrix.parameters }} --outdir ./results --test_data_base ${{ github.workspace }}/test-datasets/
234234
235-
salmon:
236-
name: Test Salmon with workflow parameters
235+
pseudo:
236+
name: Test Pseudoaligners with workflow parameters
237237
if: ${{ (github.event_name != 'push' || (github.event_name == 'push' && github.repository == 'nf-core/rnaseq')) && !contains(github.event.head_commit.message, '[ci fast]') }}
238238
runs-on: ubuntu-latest
239239
strategy:
240240
matrix:
241241
parameters:
242-
- "--skip_qc"
243-
- "--skip_alignment --skip_pseudo_alignment"
244-
- "--salmon_index false --transcript_fasta false"
242+
- "--pseudo_aligner salmon --skip_qc"
243+
- "--pseudo_aligner salmon --skip_alignment --skip_pseudo_alignment"
244+
- "--pseudo_aligner salmon --salmon_index false --transcript_fasta false"
245+
- "--pseudo_aligner kallisto --skip_qc"
246+
- "--pseudo_aligner kallisto --skip_alignment --skip_pseudo_alignment"
247+
- "--pseudo_aligner kallisto --kallisto_index false --transcript_fasta false"
245248
steps:
246249
- name: Check out pipeline code
247250
uses: actions/checkout@v2
@@ -280,6 +283,6 @@ jobs:
280283
wget -qO- get.nextflow.io | bash
281284
sudo mv nextflow /usr/local/bin/
282285
283-
- name: Run pipeline with Salmon and various parameters
286+
- name: Run pipeline with Salmon or Kallisto and various parameters
284287
run: |
285-
nextflow run ${GITHUB_WORKSPACE} -profile test_cache,docker --pseudo_aligner salmon ${{ matrix.parameters }} --outdir ./results --test_data_base ${{ github.workspace }}/test-datasets/
288+
nextflow run ${GITHUB_WORKSPACE} -profile test_cache,docker ${{ matrix.parameters }} --outdir ./results --test_data_base ${{ github.workspace }}/test-datasets/

.github/workflows/cloud_tests_full.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
compute_env: ${{ secrets.TOWER_CE_AWS_CPU }}
3131
workdir: "${{ secrets.TOWER_BUCKET_AWS }}/work/rnaseq/work-${{ github.sha }}"
3232
run_name: "aws_rnaseq_full_${{ matrix.aligner }}"
33-
profiles: test_full_aws,public_aws_ecr
33+
profiles: test_full_aws
3434
parameters: |
3535
{
3636
"hook_url": "${{ secrets.MEGATESTS_ALERTS_SLACK_HOOK_URL }}",

.github/workflows/cloud_tests_small.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jobs:
2525
compute_env: ${{ secrets.TOWER_CE_AWS_CPU }}
2626
workdir: "${{ secrets.TOWER_BUCKET_AWS }}/work/rnaseq/work-${{ github.sha }}"
2727
run_name: "aws_rnaseq_small"
28-
profiles: test,public_aws_ecr
28+
profiles: test
2929
parameters: |
3030
{
3131
"outdir": "${{ secrets.TOWER_BUCKET_AWS }}/rnaseq/results-test-${{ github.sha }}"

.github/workflows/linting.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ jobs:
7878

7979
- uses: actions/setup-python@v4
8080
with:
81-
python-version: "3.8"
81+
python-version: "3.11"
8282
architecture: "x64"
8383

8484
- name: Install dependencies
+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: release-announcements
2+
# Automatic release toot and tweet anouncements
3+
on:
4+
release:
5+
types: [published]
6+
workflow_dispatch:
7+
8+
jobs:
9+
toot:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: rzr/fediverse-action@master
13+
with:
14+
access-token: ${{ secrets.MASTODON_ACCESS_TOKEN }}
15+
host: "mstdn.science" # custom host if not "mastodon.social" (default)
16+
# GitHub event payload
17+
# https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
18+
message: |
19+
Pipeline release! ${{ github.repository }} v${{ github.event.release.tag_name }} - ${{ github.event.release.name }}!
20+
21+
Please see the changelog: ${{ github.event.release.html_url }}
22+
23+
send-tweet:
24+
runs-on: ubuntu-latest
25+
26+
steps:
27+
- uses: actions/setup-python@v4
28+
with:
29+
python-version: "3.10"
30+
- name: Install dependencies
31+
run: pip install tweepy==4.14.0
32+
- name: Send tweet
33+
shell: python
34+
run: |
35+
import os
36+
import tweepy
37+
38+
client = tweepy.Client(
39+
access_token=os.getenv("TWITTER_ACCESS_TOKEN"),
40+
access_token_secret=os.getenv("TWITTER_ACCESS_TOKEN_SECRET"),
41+
consumer_key=os.getenv("TWITTER_CONSUMER_KEY"),
42+
consumer_secret=os.getenv("TWITTER_CONSUMER_SECRET"),
43+
)
44+
tweet = os.getenv("TWEET")
45+
client.create_tweet(text=tweet)
46+
env:
47+
TWEET: |
48+
Pipeline release! ${{ github.repository }} v${{ github.event.release.tag_name }} - ${{ github.event.release.name }}!
49+
50+
Please see the changelog: ${{ github.event.release.html_url }}
51+
TWITTER_CONSUMER_KEY: ${{ secrets.TWITTER_CONSUMER_KEY }}
52+
TWITTER_CONSUMER_SECRET: ${{ secrets.TWITTER_CONSUMER_SECRET }}
53+
TWITTER_ACCESS_TOKEN: ${{ secrets.TWITTER_ACCESS_TOKEN }}
54+
TWITTER_ACCESS_TOKEN_SECRET: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}
55+
56+
bsky-post:
57+
runs-on: ubuntu-latest
58+
steps:
59+
- uses: zentered/[email protected]
60+
with:
61+
post: |
62+
Pipeline release! ${{ github.repository }} v${{ github.event.release.tag_name }} - ${{ github.event.release.name }}!
63+
64+
Please see the changelog: ${{ github.event.release.html_url }}
65+
env:
66+
BSKY_IDENTIFIER: ${{ secrets.BSKY_IDENTIFIER }}
67+
BSKY_PASSWORD: ${{ secrets.BSKY_PASSWORD }}
68+
#

.gitpod.yml

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
image: nfcore/gitpod:latest
2+
tasks:
3+
- name: Update Nextflow and setup pre-commit
4+
command: |
5+
pre-commit install --install-hooks
6+
nextflow self-update
27
38
vscode:
49
extensions: # based on nf-core.nf-core-extensionpack

.nf-core.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@ lint:
33
files_unchanged:
44
- assets/email_template.html
55
- assets/email_template.txt
6-
- lib/NfcoreSchema.groovy
76
- lib/NfcoreTemplate.groovy
7+
- pyproject.toml
8+
multiqc_config: false

CHANGELOG.md

+63-2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,67 @@
33
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
44
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
55

6+
## [[3.13.0](https://github.com/nf-core/rnaseq/releases/tag/3.13.0)] - 2023-11-17
7+
8+
### Credits
9+
10+
Special thanks to the following for their contributions to the release:
11+
12+
- [Adam Talbot](https://github.com/adamrtalbot)
13+
- [hmehlan](https://github.com/hmehlan)
14+
- [Jonathan Manning](https://github.com/pinin4fjords)
15+
- [Júlia Mir Pedrol](https://github.com/mirpedrol)
16+
- [Matthias Zepper](https://github.com/MatthiasZepper)
17+
- [Maxime Garcia](https://github.com/maxulysse)
18+
- [Steffen Möller](https://github.com/smoe)
19+
20+
Thank you to everyone else that has contributed by reporting bugs, enhancements or in any other way, shape or form.
21+
22+
### Enhancements & fixes
23+
24+
- [PR #1049](https://github.com/nf-core/rnaseq/pull/1049) - Display a warning when `--extra_star_align_args` are used with `--aligner star_rsem`
25+
- [PR #1051](https://github.com/nf-core/rnaseq/pull/1051) - Remove `public_aws_ecr` profile
26+
- [PR #1054](https://github.com/nf-core/rnaseq/pull/1054) - Template update to nf-core/tools v2.9
27+
- [PR #1058](https://github.com/nf-core/rnaseq/pull/1058) - Use `nf-validation` plugin for parameter and samplesheet validation
28+
- [PR #1068](https://github.com/nf-core/rnaseq/pull/1068) - Update `grep` version for `untar` module
29+
- [PR #1073](https://github.com/nf-core/rnaseq/pull/1073) - Update documentation to discourage use of `--genome`
30+
- [PR #1078](https://github.com/nf-core/rnaseq/pull/1078) - Updated pipeline template to [nf-core/tools 2.10](https://github.com/nf-core/tools/releases/tag/2.10)
31+
- [PR #1083](https://github.com/nf-core/rnaseq/pull/1083) - Move local modules and subworkflows to subfolders
32+
- [PR #1088](https://github.com/nf-core/rnaseq/pull/1088) - Updates contributing and code of conduct documents with nf-core template 2.10
33+
- [PR #1091](https://github.com/nf-core/rnaseq/pull/1091) - Reorganise parameters in schema for better usability
34+
- [PR #1106](https://github.com/nf-core/rnaseq/pull/1106) - Kallisto quantification
35+
- [PR #1107](https://github.com/nf-core/rnaseq/pull/1107) - Expand GTF filtering to remove rows with empty transcript ID when required, fix STAR GTF usage
36+
- [#976](https://github.com/nf-core/rnaseq/issues/976) - Add author and licenses for all custom scripts
37+
- [#1050](https://github.com/nf-core/rnaseq/issues/1050) - Provide custom prefix/suffix for summary files to avoid overwriting
38+
- [#1074](https://github.com/nf-core/rnaseq/issues/1074) - Enable quantification using StringTie AND a custom
39+
- [#1082](https://github.com/nf-core/rnaseq/issues/1082) - More informative error message for `filter_gtf_for_genes_in_genome.py`
40+
- [#1102](https://github.com/nf-core/rnaseq/issues/1102) - gene entries with empty transcript_id fields
41+
42+
### Software dependencies
43+
44+
| Dependency | Old version | New version |
45+
| ----------------------- | ----------- | ----------- |
46+
| `fastqc` | 0.11.9 | 0.12.1 |
47+
| `multiqc` | 1.14 | 1.17 |
48+
| `ucsc-bedgraphtobigwig` | 377 | 445 |
49+
50+
> **NB:** Dependency has been **updated** if both old and new version information is present.
51+
>
52+
> **NB:** Dependency has been **added** if just the new version information is present.
53+
>
54+
> **NB:** Dependency has been **removed** if new version information isn't present.
55+
56+
### Modules / Subworkflows
57+
58+
| Script | Old name | New name |
59+
| ------------------------ | ----------------- | --------------------------- |
60+
| `local/gtf_filter` | `GTF_GENE_FILTER` | `GTF_FILTER` |
61+
| `local/tx2gene` | `SALMON_TX2GENE` | `TX2GENE` |
62+
| `local/tximport` | `SALMON_TXIMPORT` | `TXIMPORT` |
63+
| `local/quantify_salmon` | `QUANTIFY_SALMON` | `QUANTIFY_PSEUDO_ALIGNMENT` |
64+
| `nf-core/kallisto_index` | | `KALLISTO_INDEX` |
65+
| `nf-core/kallisto_quant` | | `KALLISTO_QUANT` |
66+
667
## [[3.12.0](https://github.com/nf-core/rnaseq/releases/tag/3.12.0)] - 2023-06-02
768

869
### Credits
@@ -21,7 +82,7 @@ Thank you to everyone else that has contributed by reporting bugs, enhancements
2182
### Enhancements & fixes
2283

2384
- [[#1011](https://github.com/nf-core/rnaseq/issues/1011)] - FastQ files from UMI-tools not being passed to fastp
24-
- [[#1018](https://github.com/nf-core/rnaseq/issues/1018)] - Ability to skip both alignment and pseudo-alignment to only run pre-processing QC steps.
85+
- [[#1018](https://github.com/nf-core/rnaseq/issues/1018)] - Ability to skip both alignment and pseudoalignment to only run pre-processing QC steps.
2586
- [PR #1016](https://github.com/nf-core/rnaseq/pull/1016) - Updated pipeline template to [nf-core/tools 2.8](https://github.com/nf-core/tools/releases/tag/2.8)
2687
- [PR #1025](https://github.com/nf-core/fetchngs/pull/1025) - Add `public_aws_ecr.config` to source mulled containers when using `public.ecr.aws` Docker Biocontainer registry
2788
- [PR #1038](https://github.com/nf-core/rnaseq/pull/1038) - Updated error log for count values when supplying `--additional_fasta`
@@ -769,7 +830,7 @@ Major novel changes include:
769830
- Added options to skip several steps
770831
- Skip trimming using `--skipTrimming`
771832
- Skip BiotypeQC using `--skipBiotypeQC`
772-
- Skip Alignment using `--skipAlignment` to only use pseudo-alignment using Salmon
833+
- Skip Alignment using `--skipAlignment` to only use pseudoalignment using Salmon
773834

774835
### Documentation updates
775836

CITATIONS.md

+5
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
2323
- [FastQC](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/)
2424

25+
> Andrews, S. (2010). FastQC: A Quality Control Tool for High Throughput Sequence Data [Online].
26+
2527
- [featureCounts](https://pubmed.ncbi.nlm.nih.gov/24227677/)
2628

2729
> Liao Y, Smyth GK, Shi W. featureCounts: an efficient general purpose program for assigning sequence reads to genomic features. Bioinformatics. 2014 Apr 1;30(7):923-30. doi: 10.1093/bioinformatics/btt656. Epub 2013 Nov 13. PubMed PMID: 24227677.
@@ -140,5 +142,8 @@
140142
141143
- [Docker](https://dl.acm.org/doi/10.5555/2600239.2600241)
142144

145+
> Merkel, D. (2014). Docker: lightweight linux containers for consistent development and deployment. Linux Journal, 2014(239), 2. doi: 10.5555/2600239.2600241.
146+
143147
- [Singularity](https://pubmed.ncbi.nlm.nih.gov/28494014/)
148+
144149
> Kurtzer GM, Sochat V, Bauer MW. Singularity: Scientific containers for mobility of compute. PLoS One. 2017 May 11;12(5):e0177459. doi: 10.1371/journal.pone.0177459. eCollection 2017. PubMed PMID: 28494014; PubMed Central PMCID: PMC5426675.

0 commit comments

Comments
 (0)