Skip to content

Commit d434913

Browse files
committed
Template update for nf-core/tools version 2.5
1 parent 15b3da1 commit d434913

File tree

20 files changed

+193
-100
lines changed

20 files changed

+193
-100
lines changed

.editorconfig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ trim_trailing_whitespace = true
88
indent_size = 4
99
indent_style = space
1010

11-
[*.{md,yml,yaml,html,css,scss,js}]
11+
[*.{md,yml,yaml,html,css,scss,js,cff}]
1212
indent_size = 2
1313

1414
# These files are edited and tested upstream in nf-core/modules

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/rnas
1515

1616
- [ ] This comment contains a description of changes (with reason).
1717
- [ ] If you've fixed a bug or added code that should be tested, add tests!
18-
- [ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](https://github.com/nf-core/rnaseq/tree/master/.github/CONTRIBUTING.md)
19-
- [ ] If necessary, also make a PR on the nf-core/rnaseq _branch_ on the [nf-core/test-datasets](https://github.com/nf-core/test-datasets) repository.
18+
- [ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](https://github.com/nf-core/rnaseq/tree/master/.github/CONTRIBUTING.md)- [ ] If necessary, also make a PR on the nf-core/rnaseq _branch_ on the [nf-core/test-datasets](https://github.com/nf-core/test-datasets) repository.
2019
- [ ] Make sure your code lints (`nf-core lint`).
2120
- [ ] Ensure the test suite passes (`nextflow run . -profile test,docker --outdir <OUTDIR>`).
2221
- [ ] Usage Documentation in `docs/usage.md` is updated.

.github/workflows/ci.yml

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ on:
1010

1111
env:
1212
NXF_ANSI_LOG: false
13-
CAPSULE_LOG: none
1413

1514
jobs:
1615
test:
@@ -20,27 +19,17 @@ jobs:
2019
runs-on: ubuntu-latest
2120
strategy:
2221
matrix:
23-
# Nextflow versions
24-
include:
25-
# Test pipeline minimum Nextflow version
26-
- NXF_VER: "21.10.3"
27-
NXF_EDGE: ""
28-
# Test latest edge release of Nextflow
29-
- NXF_VER: ""
30-
NXF_EDGE: "1"
22+
NXF_VER:
23+
- "21.10.3"
24+
- "latest-everything"
3125
steps:
3226
- name: Check out pipeline code
3327
uses: actions/checkout@v2
3428

3529
- name: Install Nextflow
36-
env:
37-
NXF_VER: ${{ matrix.NXF_VER }}
38-
# Uncomment only if the edge release is more recent than the latest stable release
39-
# See https://github.com/nextflow-io/nextflow/issues/2467
40-
# NXF_EDGE: ${{ matrix.NXF_EDGE }}
41-
run: |
42-
wget -qO- get.nextflow.io | bash
43-
sudo mv nextflow /usr/local/bin/
30+
uses: nf-core/setup-nextflow@v1
31+
with:
32+
version: "${{ matrix.NXF_VER }}"
4433

4534
- name: Run pipeline with test data
4635
# TODO nf-core: You can customise CI pipeline run tests as required

.github/workflows/linting.yml

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,22 +35,48 @@ jobs:
3535
- name: Run Prettier --check
3636
run: prettier --check ${GITHUB_WORKSPACE}
3737

38+
PythonBlack:
39+
runs-on: ubuntu-latest
40+
steps:
41+
- uses: actions/checkout@v2
42+
43+
- name: Check code lints with Black
44+
uses: psf/black@stable
45+
46+
# If the above check failed, post a comment on the PR explaining the failure
47+
- name: Post PR comment
48+
if: failure()
49+
uses: mshick/add-pr-comment@v1
50+
with:
51+
message: |
52+
## Python linting (`black`) is failing
53+
54+
To keep the code consistent with lots of contributors, we run automated code consistency checks.
55+
To fix this CI test, please run:
56+
57+
* Install [`black`](https://black.readthedocs.io/en/stable/): `pip install black`
58+
* Fix formatting errors in your pipeline: `black .`
59+
60+
Once you push these changes the test should pass, and you can hide this comment :+1:
61+
62+
We highly recommend setting up Black in your code editor so that this formatting is done automatically on save. Ask about it on Slack for help!
63+
64+
Thanks again for your contribution!
65+
repo-token: ${{ secrets.GITHUB_TOKEN }}
66+
allow-repeats: false
67+
3868
nf-core:
3969
runs-on: ubuntu-latest
4070
steps:
4171
- name: Check out pipeline code
4272
uses: actions/checkout@v2
4373

4474
- name: Install Nextflow
45-
env:
46-
CAPSULE_LOG: none
47-
run: |
48-
wget -qO- get.nextflow.io | bash
49-
sudo mv nextflow /usr/local/bin/
75+
uses: nf-core/setup-nextflow@v1
5076

5177
- uses: actions/setup-python@v3
5278
with:
53-
python-version: "3.6"
79+
python-version: "3.7"
5480
architecture: "x64"
5581

5682
- name: Install dependencies

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
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.8dev - [date]
6+
## v3.9dev - [date]
77

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

CITATION.cff

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
cff-version: 1.2.0
2+
message: "If you use `nf-core tools` in your work, please cite the `nf-core` publication"
3+
authors:
4+
- family-names: Ewels
5+
given-names: Philip
6+
- family-names: Peltzer
7+
given-names: Alexander
8+
- family-names: Fillinger
9+
given-names: Sven
10+
- family-names: Patel
11+
given-names: Harshil
12+
- family-names: Alneberg
13+
given-names: Johannes
14+
- family-names: Wilm
15+
given-names: Andreas
16+
- family-names: Ulysse Garcia
17+
given-names: Maxime
18+
- family-names: Di Tommaso
19+
given-names: Paolo
20+
- family-names: Nahnsen
21+
given-names: Sven
22+
title: "The nf-core framework for community-curated bioinformatics pipelines."
23+
version: 2.4.1
24+
doi: 10.1038/s41587-020-0439-x
25+
date-released: 2022-05-16
26+
url: https://github.com/nf-core/tools
27+
prefered-citation:
28+
type: article
29+
authors:
30+
- family-names: Ewels
31+
given-names: Philip
32+
- family-names: Peltzer
33+
given-names: Alexander
34+
- family-names: Fillinger
35+
given-names: Sven
36+
- family-names: Patel
37+
given-names: Harshil
38+
- family-names: Alneberg
39+
given-names: Johannes
40+
- family-names: Wilm
41+
given-names: Andreas
42+
- family-names: Ulysse Garcia
43+
given-names: Maxime
44+
- family-names: Di Tommaso
45+
given-names: Paolo
46+
- family-names: Nahnsen
47+
given-names: Sven
48+
doi: 10.1038/s41587-020-0439-x
49+
journal: nature biotechnology
50+
start: 276
51+
end: 278
52+
title: "The nf-core framework for community-curated bioinformatics pipelines."
53+
issue: 3
54+
volume: 38
55+
year: 2020
56+
url: https://dx.doi.org/10.1038/s41587-020-0439-x

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) Phil Ewels, Rickard Hammarén
3+
Copyright (c) Harshil Patel, Phil Ewels, Rickard Hammarén
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,26 @@
11
# ![nf-core/rnaseq](docs/images/nf-core-rnaseq_logo_light.png#gh-light-mode-only) ![nf-core/rnaseq](docs/images/nf-core-rnaseq_logo_dark.png#gh-dark-mode-only)
22

3-
[![GitHub Actions CI Status](https://github.com/nf-core/rnaseq/workflows/nf-core%20CI/badge.svg)](https://github.com/nf-core/rnaseq/actions?query=workflow%3A%22nf-core+CI%22)
4-
[![GitHub Actions Linting Status](https://github.com/nf-core/rnaseq/workflows/nf-core%20linting/badge.svg)](https://github.com/nf-core/rnaseq/actions?query=workflow%3A%22nf-core+linting%22)
5-
[![AWS CI](https://img.shields.io/badge/CI%20tests-full%20size-FF9900?logo=Amazon%20AWS)](https://nf-co.re/rnaseq/results)
6-
[![Cite with Zenodo](http://img.shields.io/badge/DOI-10.5281/zenodo.XXXXXXX-1073c8)](https://doi.org/10.5281/zenodo.XXXXXXX)
3+
[![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)
74

85
[![Nextflow](https://img.shields.io/badge/nextflow%20DSL2-%E2%89%A521.10.3-23aa62.svg)](https://www.nextflow.io/)
9-
[![run with conda](http://img.shields.io/badge/run%20with-conda-3EB049?logo=anaconda)](https://docs.conda.io/en/latest/)
10-
[![run with docker](https://img.shields.io/badge/run%20with-docker-0db7ed?logo=docker)](https://www.docker.com/)
11-
[![run with singularity](https://img.shields.io/badge/run%20with-singularity-1d355c.svg)](https://sylabs.io/docs/)
6+
[![run with conda](http://img.shields.io/badge/run%20with-conda-3EB049?labelColor=000000&logo=anaconda)](https://docs.conda.io/en/latest/)
7+
[![run with docker](https://img.shields.io/badge/run%20with-docker-0db7ed?labelColor=000000&logo=docker)](https://www.docker.com/)
8+
[![run with singularity](https://img.shields.io/badge/run%20with-singularity-1d355c.svg?labelColor=000000)](https://sylabs.io/docs/)
129
[![Launch on Nextflow Tower](https://img.shields.io/badge/Launch%20%F0%9F%9A%80-Nextflow%20Tower-%234256e7)](https://tower.nf/launch?pipeline=https://github.com/nf-core/rnaseq)
1310

14-
[![Get help on Slack](http://img.shields.io/badge/slack-nf--core%20%23rnaseq-4A154B?logo=slack)](https://nfcore.slack.com/channels/rnaseq)
15-
[![Follow on Twitter](http://img.shields.io/badge/twitter-%40nf__core-1DA1F2?logo=twitter)](https://twitter.com/nf_core)
16-
[![Watch on YouTube](http://img.shields.io/badge/youtube-nf--core-FF0000?logo=youtube)](https://www.youtube.com/c/nf-core)
11+
[![Get help on Slack](http://img.shields.io/badge/slack-nf--core%20%23rnaseq-4A154B?labelColor=000000&logo=slack)](https://nfcore.slack.com/channels/rnaseq)[![Follow on Twitter](http://img.shields.io/badge/twitter-%40nf__core-1DA1F2?labelColor=000000&logo=twitter)](https://twitter.com/nf_core)[![Watch on YouTube](http://img.shields.io/badge/youtube-nf--core-FF0000?labelColor=000000&logo=youtube)](https://www.youtube.com/c/nf-core)
1712

1813
## Introduction
1914

2015
<!-- TODO nf-core: Write a 1-2 sentence summary of what data the pipeline is for and what it does -->
2116

22-
**nf-core/rnaseq** is a bioinformatics best-practice analysis pipeline for Nextflow RNA-Seq analysis pipeline, part of the nf-core community..
17+
**nf-core/rnaseq** is a bioinformatics best-practice analysis pipeline for RNA sequencing analysis pipeline for gene/isoform quantification and extensive quality control..
2318

2419
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 uses Docker/Singularity containers making installation trivial and results highly reproducible. The [Nextflow DSL2](https://www.nextflow.io/docs/latest/dsl2.html) implementation of this pipeline uses one container per process which makes it much easier to maintain and update software dependencies. Where possible, these processes have been submitted to and installed from [nf-core/modules](https://github.com/nf-core/modules) in order to make them available to all nf-core pipelines, and to everyone within the Nextflow community!
2520

2621
<!-- TODO nf-core: Add full-sized test dataset and amend the paragraph below if applicable -->
2722

28-
On release, automated continuous integration tests run the pipeline on a full-sized dataset on the AWS cloud infrastructure. This ensures that the pipeline runs on AWS, has sensible resource allocation defaults set to run on real-world datasets, and permits the persistent storage of results to benchmark between pipeline releases and other analysis sources. The results obtained from the full-sized test can be viewed on the [nf-core website](https://nf-co.re/rnaseq/results).
23+
On release, automated continuous integration tests run the pipeline on a full-sized dataset on the AWS cloud infrastructure. This ensures that the pipeline runs on AWS, has sensible resource allocation defaults set to run on real-world datasets, and permits the persistent storage of results to benchmark between pipeline releases and other analysis sources.The results obtained from the full-sized test can be viewed on the [nf-core website](https://nf-co.re/rnaseq/results).
2924

3025
## Pipeline summary
3126

@@ -42,7 +37,7 @@ On release, automated continuous integration tests run the pipeline on a full-si
4237

4338
3. Download the pipeline and test it on a minimal dataset with a single command:
4439

45-
```console
40+
```bash
4641
nextflow run nf-core/rnaseq -profile test,YOURPROFILE --outdir <OUTDIR>
4742
```
4843

@@ -57,7 +52,7 @@ On release, automated continuous integration tests run the pipeline on a full-si
5752

5853
<!-- TODO nf-core: Update the example "typical command" below used to run the pipeline -->
5954

60-
```console
55+
```bash
6156
nextflow run nf-core/rnaseq --input samplesheet.csv --outdir <OUTDIR> --genome GRCh37 -profile <docker/singularity/podman/shifter/charliecloud/conda/institute>
6257
```
6358

@@ -67,7 +62,7 @@ The nf-core/rnaseq pipeline comes with documentation about the pipeline [usage](
6762

6863
## Credits
6964

70-
nf-core/rnaseq was originally written by Phil Ewels, Rickard Hammarén.
65+
nf-core/rnaseq was originally written by Harshil Patel, Phil Ewels, Rickard Hammarén.
7166

7267
We thank the following people for their extensive assistance in the development of this pipeline:
7368

assets/email_template.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta http-equiv="X-UA-Compatible" content="IE=edge">
55
<meta name="viewport" content="width=device-width, initial-scale=1">
66

7-
<meta name="description" content="nf-core/rnaseq: Nextflow RNA-Seq analysis pipeline, part of the nf-core community.">
7+
<meta name="description" content="nf-core/rnaseq: RNA sequencing analysis pipeline for gene/isoform quantification and extensive quality control.">
88
<title>nf-core/rnaseq Pipeline Report</title>
99
</head>
1010
<body>

assets/email_template.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
`._,._,'
77
nf-core/rnaseq v${version}
88
----------------------------------------------------
9-
109
Run Name: $runName
1110

1211
<% if (success){

0 commit comments

Comments
 (0)