Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 11577f0

Browse files
nf-core-botnf-core-bot
committedJun 30, 2023
Template update for nf-core/tools version 2.9
1 parent 46f8bb2 commit 11577f0

23 files changed

+177
-639
lines changed
 

‎.github/CONTRIBUTING.md

-1
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

+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/awsfulltest.yml

+8-3
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,26 @@ 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
# TODO nf-core: You can customise AWS full pipeline tests as required
1919
# Add full size test data (but still relatively small datasets for few samples)
2020
# on the `test_full.config` test runs with only one set of parameters
2121
with:
2222
workspace_id: ${{ secrets.TOWER_WORKSPACE_ID }}
2323
access_token: ${{ secrets.TOWER_ACCESS_TOKEN }}
2424
compute_env: ${{ secrets.TOWER_COMPUTE_ENV }}
25+
revision: ${{ github.sha }}
2526
workdir: s3://${{ secrets.AWS_S3_BUCKET }}/work/rnaseq/work-${{ github.sha }}
2627
parameters: |
2728
{
29+
"hook_url": "${{ secrets.MEGATESTS_ALERTS_SLACK_HOOK_URL }}",
2830
"outdir": "s3://${{ secrets.AWS_S3_BUCKET }}/rnaseq/results-${{ github.sha }}"
2931
}
30-
profiles: test_full,aws_tower
32+
profiles: test_full
33+
3134
- uses: actions/upload-artifact@v3
3235
with:
3336
name: Tower debug log file
34-
path: tower_action_*.log
37+
path: |
38+
tower_action_*.log
39+
tower_action_*.json

‎.github/workflows/awstest.yml

+7-3
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/rnaseq/work-${{ github.sha }}
2122
parameters: |
2223
{
2324
"outdir": "s3://${{ secrets.AWS_S3_BUCKET }}/rnaseq/results-test-${{ github.sha }}"
2425
}
25-
profiles: test,aws_tower
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

+1-1
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

‎.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

‎CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
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-
## v3.12.0dev - [date]
6+
## v3.12.0 - [date]
77

88
Initial release of nf-core/rnaseq, created with the [nf-core](https://nf-co.re/) template.
99

‎CITATIONS.md

+6
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@
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
- [MultiQC](https://pubmed.ncbi.nlm.nih.gov/27312411/)
18+
1619
> 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.
1720
1821
## Software packaging/containerisation tools
@@ -31,5 +34,8 @@
3134
3235
- [Docker](https://dl.acm.org/doi/10.5555/2600239.2600241)
3336

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

+3-3
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/rnaseq/results)[![Cite with Zenodo](http://img.shields.io/badge/DOI-10.5281/zenodo.XXXXXXX-1073c8?labelColor=000000)](https://doi.org/10.5281/zenodo.XXXXXXX)
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/)
@@ -66,11 +66,11 @@ nextflow run nf-core/rnaseq \
6666
> provided by the `-c` Nextflow option can be used to provide any configuration _**except for parameters**_;
6767
> see [docs](https://nf-co.re/usage/configuration#custom-configuration-files).
6868
69-
For more details, please refer to the [usage documentation](https://nf-co.re/rnaseq/usage) and the [parameter documentation](https://nf-co.re/rnaseq/parameters).
69+
For more details and further functionality, please refer to the [usage documentation](https://nf-co.re/rnaseq/usage) and the [parameter documentation](https://nf-co.re/rnaseq/parameters).
7070

7171
## Pipeline output
7272

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

‎assets/methods_description_template.yml

+8-4
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,21 @@ description: "Suggested text and references to use when describing pipeline usag
33
section_name: "nf-core/rnaseq Methods Description"
44
section_href: "https://github.com/nf-core/rnaseq"
55
plot_type: "html"
6-
## TODO nf-core: Update the HTML below to your prefered methods description, e.g. add publication citation for this pipeline
6+
## TODO nf-core: Update the HTML below to your preferred methods description, e.g. add publication citation for this pipeline
77
## You inject any metadata in the Nextflow '${workflow}' object
88
data: |
99
<h4>Methods</h4>
10-
<p>Data was processed using nf-core/rnaseq 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>
10+
<p>Data was processed using nf-core/rnaseq 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>
1111
<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>
1212
<pre><code>${workflow.commandLine}</code></pre>
13+
<p>${tool_citations}</p>
1314
<h4>References</h4>
1415
<ul>
15-
<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>
16-
<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>
16+
<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>
17+
<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>
18+
<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>
19+
<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>
20+
${tool_bibliography}
1721
</ul>
1822
<div class="alert alert-info">
1923
<h5>Notes:</h5>

‎assets/multiqc_config.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
report_comment: >
2-
This report has been generated by the <a href="https://github.com/nf-core/rnaseq" target="_blank">nf-core/rnaseq</a>
2+
This report has been generated by the <a href="https://github.com/nf-core/rnaseq/3.12.0" target="_blank">nf-core/rnaseq</a>
33
analysis pipeline. For information about how to interpret these results, please see the
4-
<a href="https://nf-co.re/rnaseq" target="_blank">documentation</a>.
4+
<a href="https://nf-co.re/rnaseq/3.12.0/output" target="_blank">documentation</a>.
55
report_section_order:
66
"nf-core-rnaseq-methods-description":
77
order: -1000

‎assets/nf-core-rnaseq_logo_light.png

59.3 KB
Loading

‎assets/slackreport.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
{
44
"fallback": "Plain-text summary of the attachment.",
55
"color": "<% if (success) { %>good<% } else { %>danger<%} %>",
6-
"author_name": "sanger-tol/readmapping v${version} - ${runName}",
6+
"author_name": "nf-core/rnaseq v${version} - ${runName}",
77
"author_icon": "https://www.nextflow.io/docs/latest/_static/favicon.ico",
88
"text": "<% if (success) { %>Pipeline completed successfully!<% } else { %>Pipeline completed with errors<% } %>",
99
"fields": [

‎conf/test_full.config

-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010
----------------------------------------------------------------------------------------
1111
*/
1212

13-
cleanup = true
14-
1513
params {
1614
config_profile_name = 'Full test profile'
1715
config_profile_description = 'Full test dataset to check pipeline function'

‎docs/usage.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ An [example samplesheet](../assets/samplesheet.csv) has been provided with the p
5757
The typical command for running the pipeline is as follows:
5858

5959
```bash
60-
nextflow run nf-core/rnaseq --input samplesheet.csv --outdir <OUTDIR> --genome GRCh37 -profile docker
60+
nextflow run nf-core/rnaseq --input ./samplesheet.csv --outdir ./results --genome GRCh37 -profile docker
6161
```
6262

6363
This will launch the pipeline with the `docker` configuration profile. See below for more information about profiles.
@@ -76,7 +76,8 @@ If you wish to repeatedly use the same parameters for multiple runs, rather than
7676
Pipeline settings can be provided in a `yaml` or `json` file via `-params-file <file>`.
7777

7878
> ⚠️ Do not use `-c <file>` to specify parameters as this will result in errors. Custom config files specified with `-c` must only be used for [tuning process resource specifications](https://nf-co.re/docs/usage/configuration#tuning-workflow-resources), other infrastructural tweaks (such as output directories), or module arguments (args).
79-
> The above pipeline run specified with a params file in yaml format:
79+
80+
The above pipeline run specified with a params file in yaml format:
8081

8182
```bash
8283
nextflow run nf-core/rnaseq -profile docker -params-file params.yaml
@@ -88,7 +89,6 @@ with `params.yaml` containing:
8889
input: './samplesheet.csv'
8990
outdir: './results/'
9091
genome: 'GRCh37'
91-
input: 'data'
9292
<...>
9393
```
9494

0 commit comments

Comments
 (0)
Please sign in to comment.