Skip to content

Commit 17b2890

Browse files
authored
Merge pull request #118 from seqeralabs/migrate-to-nf-core-utils
Migrate to nf core utils
2 parents c7b82b6 + c021242 commit 17b2890

53 files changed

Lines changed: 533 additions & 1430 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: 6 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ If you'd like to write some code for seqeralabs/nf-aggregate, the standard workf
1616
1. Check that there isn't already an issue about your idea in the [seqeralabs/nf-aggregate issues](https://github.com/seqeralabs/nf-aggregate/issues) to avoid duplicating work. If there isn't one already, please create one so that others know you're working on this
1717
2. [Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the [seqeralabs/nf-aggregate repository](https://github.com/seqeralabs/nf-aggregate) to your GitHub account
1818
3. Make the necessary changes / additions within your forked repository following [Pipeline conventions](#pipeline-contribution-conventions)
19-
4. Use `nf-core pipelines schema build` and add any new parameters to the pipeline JSON schema (requires [nf-core tools](https://github.com/nf-core/tools) >= 1.10).
20-
5. Submit a Pull Request against the `dev` branch and wait for the code to be reviewed and merged
19+
4. Update `nextflow_schema.json` for any new or changed parameters.
20+
5. Submit a Pull Request against `main` and wait for the code to be reviewed and merged
2121

2222
If you're not used to this workflow with git, you can start with some [docs from GitHub](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests) or even their [excellent `git` resources](https://try.github.io/).
2323

@@ -26,13 +26,6 @@ If you're not used to this workflow with git, you can start with some [docs from
2626
When you create a pull request with changes, [GitHub Actions](https://github.com/features/actions) will run automatic tests.
2727
Typically, pull-requests are only fully reviewed when these tests are passing, though of course we can help out before then.
2828

29-
### Lint tests
30-
31-
`nf-core` has a [set of guidelines](https://nf-co.re/developers/guidelines) which all pipelines must adhere to.
32-
To enforce these and ensure that all pipelines stay in sync, we have developed a helper tool which runs checks on the pipeline code. This is in the [nf-core/tools repository](https://github.com/nf-core/tools) and once installed can be run locally with the `nf-core pipelines lint <pipeline-directory>` command.
33-
34-
If any failures or warnings are encountered, please follow the listed URL for more documentation.
35-
3629
## Patch
3730

3831
:warning: Only in the unlikely and regretful event of a release happening with a bug.
@@ -53,21 +46,21 @@ If you wish to contribute a new step, please use the following coding standards:
5346
2. Write the process block (see below).
5447
3. Define the output channel if needed (see below).
5548
4. Add any new parameters to `nextflow.config` with a default (see below).
56-
5. Add any new parameters to `nextflow_schema.json` with help text (via the `nf-core pipelines schema build` tool).
49+
5. Add any new parameters to `nextflow_schema.json` with help text.
5750
6. Add sanity checks and validation for all relevant parameters.
5851
7. Perform local tests to validate that the new code works as expected.
5952
8. If applicable, add a new test in the `tests` directory.
60-
9. Add a description of the output files to `docs/output.md`.
53+
9. Update any user-facing docs touched by the change.
6154

6255
### Default values
6356

6457
Parameters should be initialised / defined with default values within the `params` scope in `nextflow.config`.
6558

66-
Once there, use `nf-core pipelines schema build` to add to `nextflow_schema.json`.
59+
Once there, update `nextflow_schema.json` to match.
6760

6861
### Default processes resource requirements
6962

70-
Sensible defaults for process resource requirements (CPUs / memory / time) for a process should be defined in `conf/base.config`. These should generally be specified generic with `withLabel:` selectors so they can be shared across multiple processes/steps of the pipeline. A nf-core standard set of labels that should be followed where possible can be seen in the [nf-core pipeline template](https://github.com/nf-core/tools/blob/main/nf_core/pipeline-template/conf/base.config), which has the default process as a single core-process, and then different levels of multi-core configurations for increasingly large memory requirements defined with standardised labels.
63+
Set sensible defaults for process CPUs, memory, and time close to the workflow or module that owns them.
7164

7265
The process resources can be passed on to the tool dynamically within the process with the `${task.cpus}` and `${task.memory}` variables in the `script:` block.
7366

@@ -78,14 +71,6 @@ Please use the following naming schemes, to make it easy to understand what is g
7871
- initial process channel: `ch_output_from_<process>`
7972
- intermediate and terminal channels: `ch_<previousprocess>_for_<nextprocess>`
8073

81-
### Nextflow version bumping
82-
83-
If you are using a new feature from core Nextflow, you may bump the minimum required version of nextflow in the pipeline with: `nf-core pipelines bump-version --nextflow . [min-nf-version]`
84-
85-
### Images and figures
86-
87-
For overview images and other documents we follow the nf-core [style guidelines and examples](https://nf-co.re/developers/design_guidelines).
88-
8974
## GitHub Codespaces
9075

9176
This repo includes a devcontainer configuration which will create a GitHub Codespaces for Nextflow development! This is an online developer environment that runs in your browser, complete with VSCode and a terminal.
@@ -94,7 +79,6 @@ To get started:
9479

9580
- Open the repo in [Codespaces](https://github.com/seqeralabs/nf-aggregate/codespaces)
9681
- Tools installed
97-
- nf-core
9882
- Nextflow
9983

10084
Devcontainer specs:

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,15 @@ Many thanks for contributing to seqeralabs/nf-aggregate!
66
Please fill in the appropriate checklist below (delete whatever is not relevant).
77
These are the most common things requested on pull requests (PRs).
88
9-
Remember that PRs should be made against the dev branch, unless you're preparing a pipeline release.
10-
119
Learn more about contributing: [CONTRIBUTING.md](https://github.com/seqeralabs/nf-aggregate/tree/main/.github/CONTRIBUTING.md)
1210
-->
1311

1412
## PR checklist
1513

1614
- [ ] This comment contains a description of changes (with reason).
1715
- [ ] 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/seqeralabs/nf-aggregate/tree/main/.github/CONTRIBUTING.md)
19-
- [ ] Make sure your code lints (`nf-core pipelines lint`).
16+
- [ ] If you've added a new tool, parameter, or workflow path, update the relevant docs.
2017
- [ ] Ensure the test suite passes (`nextflow run . -profile test,docker --outdir <OUTDIR>`).
2118
- [ ] Check for unexpected warnings in debug mode (`nextflow run . -profile debug,test,docker --outdir <OUTDIR>`).
22-
- [ ] Usage Documentation in `docs/usage.md` is updated.
23-
- [ ] Output Documentation in `docs/output.md` is updated.
2419
- [ ] `CHANGELOG.md` is updated.
2520
- [ ] `README.md` is updated (including new tool citations and authors/contributors).

.github/workflows/clean-up.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ jobs:
1212
steps:
1313
- uses: actions/stale@28ca1036281a5e5922ead5184a1bbf96e5fc984e # v9
1414
with:
15-
stale-issue-message: "This issue has been tagged as awaiting-changes or awaiting-feedback by an nf-core contributor. Remove stale label or add a comment otherwise this issue will be closed in 20 days."
16-
stale-pr-message: "This PR has been tagged as awaiting-changes or awaiting-feedback by an nf-core contributor. Remove stale label or add a comment if it is still useful."
17-
close-issue-message: "This issue was closed because it has been tagged as awaiting-changes or awaiting-feedback by an nf-core contributor and then staled for 20 days with no activity."
15+
stale-issue-message: "This issue has been tagged as awaiting-changes or awaiting-feedback by a maintainer. Remove the stale label or add a comment, otherwise this issue will be closed in 20 days."
16+
stale-pr-message: "This PR has been tagged as awaiting-changes or awaiting-feedback by a maintainer. Remove the stale label or add a comment if it is still useful."
17+
close-issue-message: "This issue was closed because it was tagged as awaiting-changes or awaiting-feedback and then remained stale for 20 days."
1818
days-before-stale: 30
1919
days-before-close: 20
2020
days-before-pr-close: -1

.github/workflows/linting.yml

Lines changed: 0 additions & 27 deletions
This file was deleted.

.github/workflows/nf-test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ jobs:
8484
- isMain: false
8585
profile: "singularity"
8686
NXF_VER:
87-
- "24.04.2"
87+
- "25.10.0"
8888
- "latest-everything"
8989
env:
9090
NXF_ANSI_LOG: false

.nf-core.yml

Lines changed: 0 additions & 63 deletions
This file was deleted.

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# nf-aggregate
22

3-
Nextflow pipeline to aggregate metrics across Seqera Platform pipeline runs. nf-core template based (v3.3.0.dev0).
3+
Nextflow pipeline to aggregate metrics across Seqera Platform pipeline runs.
44

55
## Architecture
66

CITATIONS.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# seqeralabs/nf-aggregate: Citations
22

3-
## [nf-core](https://pubmed.ncbi.nlm.nih.gov/32055031/)
4-
5-
> Ewels PA, Peltzer A, Fillinger S, Patel H, Alneberg J, Wilm A, Garcia MU, Di Tommaso P, Nahnsen S. The nf-core framework for community-curated bioinformatics pipelines. Nat Biotechnol. 2020 Mar;38(3):276-278. doi: 10.1038/s41587-020-0439-x. PubMed PMID: 32055031.
6-
73
## [Nextflow](https://pubmed.ncbi.nlm.nih.gov/28398311/)
84

95
> Di Tommaso P, Chatzou M, Floden EW, Barja PP, Palumbo E, Notredame C. Nextflow enables reproducible computational workflows. Nat Biotechnol. 2017 Apr 11;35(4):316-319. doi: 10.1038/nbt.3820. PubMed PMID: 28398311.

README.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
# seqeralabs/nf-aggregate
22

33
[![GitHub Actions CI Status](https://github.com/seqeralabs/nf-aggregate/actions/workflows/ci.yml/badge.svg)](https://github.com/seqeralabs/nf-aggregate/actions/workflows/ci.yml)
4-
[![GitHub Actions Linting Status](https://github.com/seqeralabs/nf-aggregate/actions/workflows/linting.yml/badge.svg)](https://github.com/seqeralabs/nf-aggregate/actions/workflows/linting.yml)
54
[![nf-test](https://img.shields.io/badge/unit_tests-nf--test-337ab7.svg)](https://www.nf-test.com)
65

7-
[![Nextflow](https://img.shields.io/badge/version-%E2%89%A524.04.2-green?style=flat&logo=nextflow&logoColor=white&color=%230DC09D&link=https%3A%2F%2Fnextflow.io)](https://www.nextflow.io/)
8-
[![nf-core template version](https://img.shields.io/badge/nf--core_template-3.3.1-green?style=flat&logo=nfcore&logoColor=white&color=%2324B064&link=https%3A%2F%2Fnf-co.re)](https://github.com/nf-core/tools/releases/tag/3.3.1)
6+
[![Nextflow](https://img.shields.io/badge/version-%E2%89%A525.10.0-green?style=flat&logo=nextflow&logoColor=white&color=%230DC09D&link=https%3A%2F%2Fnextflow.io)](https://www.nextflow.io/)
97
[![run with conda](http://img.shields.io/badge/run%20with-conda-3EB049?labelColor=000000&logo=anaconda)](https://docs.conda.io/en/latest/)
108
[![run with docker](https://img.shields.io/badge/run%20with-docker-0db7ed?labelColor=000000&logo=docker)](https://www.docker.com/)
119
[![run with singularity](https://img.shields.io/badge/run%20with-singularity-1d355c.svg?labelColor=000000)](https://sylabs.io/docs/)
@@ -19,7 +17,7 @@ The pipeline fetches run data from the Seqera Platform API and generates benchma
1917

2018
## Prerequisites
2119

22-
- [Nextflow](https://www.nextflow.io/docs/latest/getstarted.html#installation) >=23.10.0
20+
- [Nextflow](https://www.nextflow.io/docs/latest/getstarted.html#installation) >=25.10.0
2321
- Account in [Seqera Platform](https://seqera.io/platform/)
2422
- [Access token](https://docs.seqera.io/platform/23.3.0/api/overview#authentication) which is your personal authorization token for the Seqera Platform CLI. This can be created in the user menu under **Your tokens**. Export the token as a shell variable directly into your terminal if running the pipelie locally. You will not need to set this if running the pipeline within the Seqera Platform as it will automatically be inherited from the executing environment.
2523

@@ -108,12 +106,4 @@ nf-aggregate was written by the Scientific Development team at [Seqera Labs](htt
108106

109107
## Citations
110108

111-
This pipeline uses code and infrastructure developed and maintained by the [nf-core](https://nf-co.re) community, reused here under the [MIT license](https://github.com/nf-core/tools/blob/master/LICENSE).
112-
113-
You can cite the `nf-core` publication as follows:
114-
115-
> **The nf-core framework for community-curated bioinformatics pipelines.**
116-
>
117-
> Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.
118-
>
119-
> _Nat Biotechnol._ 2020 Feb 13. doi: [10.1038/s41587-020-0439-x](https://dx.doi.org/10.1038/s41587-020-0439-x).
109+
See [CITATIONS.md](CITATIONS.md).

lib/AGENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Auto-loaded by Nextflow at pipeline startup. Available in workflow/process scrip
44

55
## SeqeraApi.groovy
66

7-
nf-boost `request()` wrappers for Seqera Platform API. Used in the v2 benchmark path — called directly in `map{}` operators, no container needed.
7+
Plain `java.net.URL.openConnection()` HTTP client for Seqera Platform API. Used in the v2 benchmark path — called directly in `map{}` operators, no container needed.
88

99
### Methods
1010

@@ -32,6 +32,6 @@ Calls `/orgs` → finds org by name → calls `/orgs/{orgId}/workspaces` → fin
3232

3333
### Gotchas
3434

35-
- Uses `nextflow.boost.BoostFunctions` — requires `nf-boost` plugin
35+
- Uses plain `java.net.URL.openConnection()` for HTTP requests — no external plugin dependency
3636
- Runs in the Nextflow head JVM, not in a container process
3737
- Network errors throw `RuntimeException` which will fail the pipeline

0 commit comments

Comments
 (0)