You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+6-22Lines changed: 6 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,8 +16,8 @@ If you'd like to write some code for seqeralabs/nf-aggregate, the standard workf
16
16
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
17
17
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
18
18
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
21
21
22
22
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/).
23
23
@@ -26,13 +26,6 @@ If you're not used to this workflow with git, you can start with some [docs from
26
26
When you create a pull request with changes, [GitHub Actions](https://github.com/features/actions) will run automatic tests.
27
27
Typically, pull-requests are only fully reviewed when these tests are passing, though of course we can help out before then.
28
28
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
-
36
29
## Patch
37
30
38
31
: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:
53
46
2. Write the process block (see below).
54
47
3. Define the output channel if needed (see below).
55
48
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.
57
50
6. Add sanity checks and validation for all relevant parameters.
58
51
7. Perform local tests to validate that the new code works as expected.
59
52
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.
61
54
62
55
### Default values
63
56
64
57
Parameters should be initialised / defined with default values within the `params` scope in `nextflow.config`.
65
58
66
-
Once there, use `nf-core pipelines schema build` to add to `nextflow_schema.json`.
59
+
Once there, update `nextflow_schema.json` to match.
67
60
68
61
### Default processes resource requirements
69
62
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.
71
64
72
65
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.
73
66
@@ -78,14 +71,6 @@ Please use the following naming schemes, to make it easy to understand what is g
78
71
- initial process channel: `ch_output_from_<process>`
79
72
- intermediate and terminal channels: `ch_<previousprocess>_for_<nextprocess>`
80
73
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
-
89
74
## GitHub Codespaces
90
75
91
76
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:
94
79
95
80
- Open the repo in [Codespaces](https://github.com/seqeralabs/nf-aggregate/codespaces)
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+1-6Lines changed: 1 addition & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,20 +6,15 @@ Many thanks for contributing to seqeralabs/nf-aggregate!
6
6
Please fill in the appropriate checklist below (delete whatever is not relevant).
7
7
These are the most common things requested on pull requests (PRs).
8
8
9
-
Remember that PRs should be made against the dev branch, unless you're preparing a pipeline release.
10
-
11
9
Learn more about contributing: [CONTRIBUTING.md](https://github.com/seqeralabs/nf-aggregate/tree/main/.github/CONTRIBUTING.md)
12
10
-->
13
11
14
12
## PR checklist
15
13
16
14
-[ ] This comment contains a description of changes (with reason).
17
15
-[ ] 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.
20
17
-[ ] Ensure the test suite passes (`nextflow run . -profile test,docker --outdir <OUTDIR>`).
21
18
-[ ] 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.
24
19
-[ ]`CHANGELOG.md` is updated.
25
20
-[ ]`README.md` is updated (including new tool citations and authors/contributors).
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."
Copy file name to clipboardExpand all lines: README.md
+3-13Lines changed: 3 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,9 @@
1
1
# seqeralabs/nf-aggregate
2
2
3
3
[](https://github.com/seqeralabs/nf-aggregate/actions/workflows/ci.yml)
- Account in [Seqera Platform](https://seqera.io/platform/)
24
22
-[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.
25
23
@@ -108,12 +106,4 @@ nf-aggregate was written by the Scientific Development team at [Seqera Labs](htt
108
106
109
107
## Citations
110
108
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).
Copy file name to clipboardExpand all lines: lib/AGENTS.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ Auto-loaded by Nextflow at pipeline startup. Available in workflow/process scrip
4
4
5
5
## SeqeraApi.groovy
6
6
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.
8
8
9
9
### Methods
10
10
@@ -32,6 +32,6 @@ Calls `/orgs` → finds org by name → calls `/orgs/{orgId}/workspaces` → fin
0 commit comments