Skip to content

Commit e6b6e5a

Browse files
authored
Merge pull request #277 from nf-core/dev
Release PR for 2.2.2 Patch Release
2 parents f7022ab + d0be63a commit e6b6e5a

48 files changed

Lines changed: 458 additions & 763 deletions

Some content is hidden

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

.github/CONTRIBUTING.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,4 +116,3 @@ To get started:
116116
Devcontainer specs:
117117

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

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 1 addition & 1 deletion
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/awsfulltest.yml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,23 @@ jobs:
1414
runs-on: ubuntu-latest
1515
steps:
1616
- name: Launch workflow via tower
17-
uses: seqeralabs/action-tower-launch@v1
17+
uses: seqeralabs/action-tower-launch@v2
1818
with:
1919
workspace_id: ${{ secrets.TOWER_WORKSPACE_ID }}
2020
access_token: ${{ secrets.TOWER_ACCESS_TOKEN }}
2121
compute_env: ${{ secrets.TOWER_COMPUTE_ENV }}
22+
revision: ${{ github.sha }}
2223
workdir: s3://${{ secrets.AWS_S3_BUCKET }}/work/smrnaseq/work-${{ github.sha }}
2324
parameters: |
2425
{
26+
"hook_url": "${{ secrets.MEGATESTS_ALERTS_SLACK_HOOK_URL }}",
2527
"outdir": "s3://${{ secrets.AWS_S3_BUCKET }}/smrnaseq/results-${{ github.sha }}"
2628
}
27-
profiles: test_full,public_aws_ecr
29+
profiles: test_full
30+
2831
- uses: actions/upload-artifact@v3
2932
with:
3033
name: Tower debug log file
31-
path: tower_action_*.log
34+
path: |
35+
tower_action_*.log
36+
tower_action_*.json

.github/workflows/awstest.yml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,22 @@ jobs:
1212
steps:
1313
# Launch workflow using Tower CLI tool action
1414
- name: Launch workflow via tower
15-
uses: seqeralabs/action-tower-launch@v1
15+
uses: seqeralabs/action-tower-launch@v2
1616
with:
1717
workspace_id: ${{ secrets.TOWER_WORKSPACE_ID }}
1818
access_token: ${{ secrets.TOWER_ACCESS_TOKEN }}
1919
compute_env: ${{ secrets.TOWER_COMPUTE_ENV }}
20+
revision: ${{ github.sha }}
2021
workdir: s3://${{ secrets.AWS_S3_BUCKET }}/work/smrnaseq/work-${{ github.sha }}
2122
parameters: |
2223
{
2324
"outdir": "s3://${{ secrets.AWS_S3_BUCKET }}/smrnaseq/results-test-${{ github.sha }}"
2425
}
25-
profiles: test,public_aws_ecr
26+
profiles: test
27+
2628
- uses: actions/upload-artifact@v3
2729
with:
2830
name: Tower debug log file
29-
path: tower_action_*.log
31+
path: |
32+
tower_action_*.log
33+
tower_action_*.json

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
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
profile:
3030
- "test"

.gitpod.yml

Lines changed: 5 additions & 0 deletions
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

CHANGELOG.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,21 @@
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-
## [v2.2.1](https://github.com/nf-core/smrnaseq/releases/tag/2.2.1) - 2023-05-08
6+
## [v2.2.2](https://github.com/nf-core/smrnaseq/releases/tag/2.2.2) - 2023-09-04
7+
8+
- [[#253]](https://github.com/nf-core/smrnaseq/pull/253) - Remove globs from process alias when using ECR containers
9+
- [[#237]](https://github.com/nf-core/smrnaseq/issues/237) - Fix illumina protocol clip parameters to default
10+
- Remove public_aws_ecr profile
11+
- [[#269]](https://github.com/nf-core/smrnaseq/pull/269) - Updated miRBase URLs with new location (old ones were broken)
12+
13+
### Software dependencies
14+
15+
| Dependency | Old version | New version |
16+
| ---------- | ----------- | ----------- |
17+
| `multiqc` | 1.13 | 1.15 |
18+
| `fastp` | 0.23.2 | 0.23.4 |
19+
20+
## [v2.2.1](https://github.com/nf-core/smrnaseq/releases/tag/2.2.1) - 2023-05-12
721

822
### Enhancements & fixes
923

CITATIONS.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212

1313
- [FastQC](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/)
1414

15+
> Andrews, S. (2010). FastQC: A Quality Control Tool for High Throughput Sequence Data [Online]. Available online https://www.bioinformatics.babraham.ac.uk/projects/fastqc/.
16+
1517
* [trimgalore](https://www.bioinformatics.babraham.ac.uk/projects/trim_galore/)
1618

1719
* [samtools](https://pubmed.ncbi.nlm.nih.gov/19505943/)
@@ -56,5 +58,8 @@
5658
5759
- [Docker](https://dl.acm.org/doi/10.5555/2600239.2600241)
5860

61+
> Merkel, D. (2014). Docker: lightweight linux containers for consistent development and deployment. Linux Journal, 2014(239), 2. doi: 10.5555/2600239.2600241.
62+
5963
- [Singularity](https://pubmed.ncbi.nlm.nih.gov/28494014/)
64+
6065
> 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.

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![AWS CI](https://img.shields.io/badge/CI%20tests-full%20size-FF9900?labelColor=000000&logo=Amazon%20AWS)](https://nf-co.re/smrnaseq/results)[![Cite with Zenodo](http://img.shields.io/badge/DOI-10.5281/zenodo.3456879-1073c8?labelColor=000000)](https://doi.org/10.5281/zenodo.3456879)
44

5-
[![Nextflow](https://img.shields.io/badge/nextflow%20DSL2-%E2%89%A522.10.1-23aa62.svg)](https://www.nextflow.io/)
5+
[![Nextflow](https://img.shields.io/badge/nextflow%20DSL2-%E2%89%A523.04.0-23aa62.svg)](https://www.nextflow.io/)
66
[![run with conda](http://img.shields.io/badge/run%20with-conda-3EB049?labelColor=000000&logo=anaconda)](https://docs.conda.io/en/latest/)
77
[![run with docker](https://img.shields.io/badge/run%20with-docker-0db7ed?labelColor=000000&logo=docker)](https://www.docker.com/)
88
[![run with singularity](https://img.shields.io/badge/run%20with-singularity-1d355c.svg?labelColor=000000)](https://sylabs.io/docs/)
@@ -57,46 +57,46 @@ You can find numerous talks on the nf-core events page from various topics inclu
5757
> to set-up Nextflow. Make sure to [test your setup](https://nf-co.re/docs/usage/introduction#how-to-run-a-pipeline)
5858
> with `-profile test` before running the workflow on actual data.
5959
60-
<!-- TODO nf-core: Describe the minimum required steps to execute the pipeline, e.g. how to prepare samplesheets.
61-
Explain what rows and columns represent. For instance (please edit as appropriate):
62-
6360
First, prepare a samplesheet with your input data that looks as follows:
6461

6562
`samplesheet.csv`:
6663

6764
```csv
6865
sample,fastq_1
69-
CONTROL_REP1,AEG588A1_S1_L002_001.fastq.gz
66+
Clone1_N1,s3://ngi-igenomes/test-data/smrnaseq/C1-N1-R1_S4_L001_R1_001.fastq.gz
67+
Clone1_N3,s3://ngi-igenomes/test-data/smrnaseq/C1-N3-R1_S6_L001_R1_001.fastq.gz
68+
Clone9_N1,s3://ngi-igenomes/test-data/smrnaseq/C9-N1-R1_S7_L001_R1_001.fastq.gz
69+
Clone9_N2,s3://ngi-igenomes/test-data/smrnaseq/C9-N2-R1_S8_L001_R1_001.fastq.gz
70+
Clone9_N3,s3://ngi-igenomes/test-data/smrnaseq/C9-N3-R1_S9_L001_R1_001.fastq.gz
71+
Control_N1,s3://ngi-igenomes/test-data/smrnaseq/Ctl-N1-R1_S1_L001_R1_001.fastq.gz
72+
Control_N2,s3://ngi-igenomes/test-data/smrnaseq/Ctl-N2-R1_S2_L001_R1_001.fastq.gz
73+
Control_N3,s3://ngi-igenomes/test-data/smrnaseq/Ctl-N3-R1_S3_L001_R1_001.fastq.gz
7074
```
7175

7276
Each row represents a fastq file (single-end).
7377

74-
-->
75-
7678
Now, you can run the pipeline using:
7779

78-
<!-- TODO nf-core: update the following command to include all required parameters for a minimal example -->
79-
8080
```bash
8181
nextflow run nf-core/smrnaseq \
8282
-profile <docker/singularity/.../institute> \
83-
--input samplesheet.csv \
84-
--genome 'GRCh37' \
85-
--mirtrace_species 'hsa' \
86-
--protocol 'illumina' \
87-
--outdir <OUTDIR>
83+
--input samplesheet.csv \
84+
--genome 'GRCh37' \
85+
--mirtrace_species 'hsa' \
86+
--protocol 'illumina' \
87+
--outdir <OUTDIR>
8888
```
8989

9090
> **Warning:**
9191
> Please provide pipeline parameters via the CLI or Nextflow `-params-file` option. Custom config files including those
9292
> provided by the `-c` Nextflow option can be used to provide any configuration _**except for parameters**_;
9393
> see [docs](https://nf-co.re/usage/configuration#custom-configuration-files).
9494
95-
For more details, please refer to the [usage documentation](https://nf-co.re/smrnaseq/usage) and the [parameter documentation](https://nf-co.re/smrnaseq/parameters).
95+
For more details and further functionality, please refer to the [usage documentation](https://nf-co.re/smrnaseq/usage) and the [parameter documentation](https://nf-co.re/smrnaseq/parameters).
9696

9797
## Pipeline output
9898

99-
To see the the results of a test run with a full size dataset refer to the [results](https://nf-co.re/smrnaseq/results) tab on the nf-core website pipeline page.
99+
To see the results of an example test run with a full size dataset refer to the [results](https://nf-co.re/smrnaseq/results) tab on the nf-core website pipeline page.
100100
For more details about the output files and reports, please refer to the
101101
[output documentation](https://nf-co.re/smrnaseq/output).
102102

assets/methods_description_template.yml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,17 @@ section_href: "https://github.com/nf-core/smrnaseq"
55
plot_type: "html"
66
data: |
77
<h4>Methods</h4>
8-
<p>Data was processed using nf-core/smrnaseq v${workflow.manifest.version} ${doi_text} of the nf-core collection of workflows (<a href="https://doi.org/10.1038/s41587-020-0439-x">Ewels <em>et al.</em>, 2020</a>).</p>
8+
<p>Data was processed using nf-core/smrnaseq v${workflow.manifest.version} ${doi_text} of the nf-core collection of workflows (<a href="https://doi.org/10.1038/s41587-020-0439-x">Ewels <em>et al.</em>, 2020</a>), utilising reproducible software environments from the Bioconda (<a href="https://doi.org/10.1038/s41592-018-0046-7">Grüning <em>et al.</em>, 2018</a>) and Biocontainers (<a href="https://doi.org/10.1093/bioinformatics/btx192">da Veiga Leprevost <em>et al.</em>, 2017</a>) projects.</p>
99
<p>The pipeline was executed with Nextflow v${workflow.nextflow.version} (<a href="https://doi.org/10.1038/nbt.3820">Di Tommaso <em>et al.</em>, 2017</a>) with the following command:</p>
1010
<pre><code>${workflow.commandLine}</code></pre>
11+
<p>${tool_citations}</p>
1112
<h4>References</h4>
1213
<ul>
13-
<li>Di Tommaso, P., Chatzou, M., Floden, E. W., Barja, P. P., Palumbo, E., & Notredame, C. (2017). Nextflow enables reproducible computational workflows. Nature Biotechnology, 35(4), 316-319. <a href="https://doi.org/10.1038/nbt.3820">https://doi.org/10.1038/nbt.3820</a></li>
14-
<li>Ewels, P. A., Peltzer, A., Fillinger, S., Patel, H., Alneberg, J., Wilm, A., Garcia, M. U., Di Tommaso, P., & Nahnsen, S. (2020). The nf-core framework for community-curated bioinformatics pipelines. Nature Biotechnology, 38(3), 276-278. <a href="https://doi.org/10.1038/s41587-020-0439-x">https://doi.org/10.1038/s41587-020-0439-x</a></li>
14+
<li>Di Tommaso, P., Chatzou, M., Floden, E. W., Barja, P. P., Palumbo, E., & Notredame, C. (2017). Nextflow enables reproducible computational workflows. Nature Biotechnology, 35(4), 316-319. doi: <a href="https://doi.org/10.1038/nbt.3820">10.1038/nbt.3820</a></li>
15+
<li>Ewels, P. A., Peltzer, A., Fillinger, S., Patel, H., Alneberg, J., Wilm, A., Garcia, M. U., Di Tommaso, P., & Nahnsen, S. (2020). The nf-core framework for community-curated bioinformatics pipelines. Nature Biotechnology, 38(3), 276-278. doi: <a href="https://doi.org/10.1038/s41587-020-0439-x">10.1038/s41587-020-0439-x</a></li>
16+
<li>Grüning, B., Dale, R., Sjödin, A., Chapman, B. A., Rowe, J., Tomkins-Tinch, C. H., Valieris, R., Köster, J., & Bioconda Team. (2018). Bioconda: sustainable and comprehensive software distribution for the life sciences. Nature Methods, 15(7), 475–476. doi: <a href="https://doi.org/10.1038/s41592-018-0046-7">10.1038/s41592-018-0046-7</a></li>
17+
<li>da Veiga Leprevost, F., Grüning, B. A., Alves Aflitos, S., Röst, H. L., Uszkoreit, J., Barsnes, H., Vaudel, M., Moreno, P., Gatto, L., Weber, J., Bai, M., Jimenez, R. C., Sachsenberg, T., Pfeuffer, J., Vera Alvarez, R., Griss, J., Nesvizhskii, A. I., & Perez-Riverol, Y. (2017). BioContainers: an open-source and community-driven framework for software standardization. Bioinformatics (Oxford, England), 33(16), 2580–2582. doi: <a href="https://doi.org/10.1093/bioinformatics/btx192">10.1093/bioinformatics/btx192</a></li>
18+
${tool_bibliography}
1519
</ul>
1620
<div class="alert alert-info">
1721
<h5>Notes:</h5>

0 commit comments

Comments
 (0)