Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 3.5.0 #1750

Merged
merged 399 commits into from
Dec 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
399 commits
Select commit Hold shift + click to select a range
102ea37
exclude tests for diff
maxulysse Sep 23, 2024
8368eae
exclude tests because of missing dependency
maxulysse Sep 23, 2024
8c5e8e7
add default values for new options
maxulysse Sep 23, 2024
ac569b4
fix usage
maxulysse Sep 23, 2024
92e3907
typo
maxulysse Sep 23, 2024
2dd70b9
Update CHANGELOG.md
maxulysse Sep 23, 2024
a2a1462
fix bcftools annotate usage
maxulysse Sep 23, 2024
a4f07f7
Merge pull request #1656 from asp8200/modify_snpeff_cache_setup
maxulysse Sep 23, 2024
474a9da
Merge branch 'dev' into massive_conda_update
maxulysse Sep 23, 2024
73c9f0e
exclude tests because of missing dependency
maxulysse Sep 23, 2024
782d0a9
Fix default value
maxulysse Sep 24, 2024
1c02dfd
fix usage of GATK4_GENOTYPEGVCFS
maxulysse Sep 24, 2024
d61d456
fix expected content
maxulysse Sep 24, 2024
f939581
exclude tests coming from modules
maxulysse Sep 24, 2024
4e5adf4
fix usage
maxulysse Sep 24, 2024
2c4225a
exclude tests coming from modules + use debug
maxulysse Sep 24, 2024
240db8d
update CHANGELOG
maxulysse Sep 24, 2024
f148972
properly update samtools
maxulysse Sep 24, 2024
42d9e32
fix expected filename
maxulysse Sep 24, 2024
4922d11
Merge branch 'dev' into dev
nevinwu Sep 30, 2024
4c664f4
Merge pull request #1653 from nevinwu/dev
nevinwu Sep 30, 2024
6c19405
use nft-utils
maxulysse Oct 1, 2024
c1ab3de
let's capture ALL paths
maxulysse Oct 1, 2024
6e7655f
Merge pull request #1661 from maxulysse/pipeline_test
maxulysse Oct 1, 2024
7dfc927
relative path
maxulysse Oct 2, 2024
2067cb0
update CHANGELOG
maxulysse Oct 2, 2024
2736aac
print warnings instead of erroring
maxulysse Oct 3, 2024
a0dc4fb
no need to import
maxulysse Oct 3, 2024
0aafe1b
no need to import
maxulysse Oct 3, 2024
900a6c7
fix comments
maxulysse Oct 3, 2024
181af2b
update CHANGELOG
maxulysse Oct 3, 2024
5e19aee
Merge branch 'dev' into fix_previously_silent_error
maxulysse Oct 3, 2024
9e0fda5
Merge pull request #1669 from maxulysse/better_snapshots
maxulysse Oct 3, 2024
70b10c3
Merge branch 'dev' into fix_previously_silent_error
maxulysse Oct 3, 2024
2be5d14
Merge pull request #1673 from maxulysse/fix_previously_silent_error
maxulysse Oct 3, 2024
d080950
Merge branch 'dev' into massive_conda_update
maxulysse Oct 3, 2024
04ee9bd
Merge branch 'dev' into massive_conda_update
maxulysse Oct 3, 2024
379a395
update snapshot
maxulysse Oct 3, 2024
a259f23
update MultiQC
maxulysse Oct 3, 2024
a0276b0
add pdiff
maxulysse Oct 3, 2024
9439e62
proper indent of comment
maxulysse Oct 3, 2024
ad029e3
add junitxml
maxulysse Oct 3, 2024
0ce964c
update .nftignore and snap
maxulysse Oct 3, 2024
e9d4301
update nftignore
maxulysse Oct 3, 2024
1856529
enhance pdiff
maxulysse Oct 3, 2024
2cb5136
patch deepvariant tests
maxulysse Oct 3, 2024
d8e83d8
fix path
maxulysse Oct 3, 2024
edd0624
actually add the file
maxulysse Oct 3, 2024
08be956
no md5sum
maxulysse Oct 3, 2024
e9a0c1e
Merge pull request #1663 from nf-core/massive_conda_update
maxulysse Oct 3, 2024
1c3cabd
Merge branch 'dev' into pl_goleft
maxulysse Oct 4, 2024
5415caa
Merge branch 'dev' into master
maxulysse Oct 4, 2024
5e7f6f5
migrate pytest aligner tests to nf-test
maxulysse Oct 7, 2024
e9f0fb9
update CHANGELOG
maxulysse Oct 7, 2024
1d9a18e
install pdiff
maxulysse Oct 7, 2024
b7417ec
properly install pdiff
maxulysse Oct 7, 2024
89507f8
update nftignore and snapshots
maxulysse Oct 7, 2024
7b7b9c1
update CHANGELOG
maxulysse Oct 8, 2024
1bfe04a
add tumor-normal-pair test
maxulysse Oct 8, 2024
c9b2f0d
update CHANGELOG
maxulysse Oct 8, 2024
0c5114f
add more tests, update to nft-utils 0.0.3, add nft-bam 0.4.0
maxulysse Oct 8, 2024
977389f
fix snapshots
maxulysse Oct 8, 2024
d31edb8
ignore bam files from snapshots
maxulysse Oct 8, 2024
1e82940
ignore bai files from snapshots
maxulysse Oct 8, 2024
4713bad
snapshot bam files
maxulysse Oct 8, 2024
56791a2
update nftignore - no files from multiqc_plots
maxulysse Oct 8, 2024
2c9d25b
update snapshots + snapshot bam files using nft-bam
maxulysse Oct 8, 2024
4db3c99
snapshot bam files
maxulysse Oct 8, 2024
5634713
properly update nftignore - no files from multiqc_plots
maxulysse Oct 8, 2024
6dd2fd6
snapshot cram files with nft-bam
maxulysse Oct 8, 2024
61f19fd
update snapshots
maxulysse Oct 8, 2024
ab16157
update nftignore
maxulysse Oct 8, 2024
dfba0bf
Template update for nf-core/tools version 3.0.0
nf-core-bot Oct 8, 2024
fffd678
Merge branch 'dev' into nf-core-template-merge-3.0.0
maxulysse Oct 8, 2024
5c20a59
rescue merge conflicts
maxulysse Oct 8, 2024
3991416
fix schema
maxulysse Oct 8, 2024
18a659a
fix schema
maxulysse Oct 8, 2024
a773399
prettier
maxulysse Oct 8, 2024
846e224
fix linting
maxulysse Oct 8, 2024
6ecbec3
commit file
maxulysse Oct 8, 2024
5012196
fix lint
maxulysse Oct 8, 2024
2fe616d
fix GHA
maxulysse Oct 8, 2024
7240429
prettier 3.0.3
maxulysse Oct 8, 2024
a40f907
commit file
maxulysse Oct 8, 2024
2f81646
nf-core lint
maxulysse Oct 8, 2024
be7cc03
fix linting
maxulysse Oct 8, 2024
945dd9b
disable that
maxulysse Oct 8, 2024
25709f7
do not care about local prettier or local eclint or local nf-core lint
maxulysse Oct 8, 2024
b235f48
fix nf-core lint
maxulysse Oct 8, 2024
9da878a
no prettier
maxulysse Oct 9, 2024
072c7a0
prettier
maxulysse Oct 9, 2024
52e99f7
fix configs
maxulysse Oct 9, 2024
de7ba6a
fix schema usage
maxulysse Oct 9, 2024
ccd54f6
fix ignore
maxulysse Oct 9, 2024
4abde1c
fix configs for real
maxulysse Oct 9, 2024
489289d
bump minimal nextflow in GHA
maxulysse Oct 9, 2024
3f4c650
empty file
maxulysse Oct 9, 2024
6f79ac0
file from TEMPLATE
maxulysse Oct 9, 2024
8d7cc5d
grabing from the TEMPLATE branch
maxulysse Oct 9, 2024
0d0e5e8
hook_url
maxulysse Oct 9, 2024
bfb35ab
Apply suggestions from code review
maxulysse Oct 9, 2024
4764acd
Template update for nf-core/tools version 3.0.1
nf-core-bot Oct 9, 2024
0e88ba1
Merge pull request #1680 from nf-core/nf-core-template-merge-3.0.0
maxulysse Oct 9, 2024
813bab6
Merge branch 'dev' into nf-core-template-merge-3.0.1
maxulysse Oct 9, 2024
72deb6b
no need to ignore anymore
maxulysse Oct 9, 2024
043cf24
try to fix GHA
maxulysse Oct 9, 2024
49e373e
no need to change
maxulysse Oct 9, 2024
3c9c39b
inline description
maxulysse Oct 9, 2024
242152b
use [email protected]
maxulysse Oct 9, 2024
cc3df7e
update GHA
maxulysse Oct 9, 2024
bc47278
update CHANGELOG
maxulysse Oct 9, 2024
cfce331
use minimal-read-yaml action to read a yaml file
mirpedrol Oct 10, 2024
4067d1e
fix the template_version_comment GHA
mirpedrol Oct 10, 2024
a6a7eca
Merge pull request #1684 from mirpedrol/fix-template_version_comment_gha
maxulysse Oct 10, 2024
0ff02cf
Merge branch 'dev' into nf-core-template-merge-3.0.1
maxulysse Oct 10, 2024
e4e5e02
Merge pull request #1681 from nf-core/nf-core-template-merge-3.0.1
maxulysse Oct 10, 2024
752f66a
Merge branch 'dev' into nft-utils-0-0-3
maxulysse Oct 11, 2024
b3f9611
fix test
maxulysse Oct 11, 2024
496b146
Merge branch 'nft-utils-0-0-3' of github.com:maxulysse/nf-core_sarek …
maxulysse Oct 11, 2024
6420256
Update nf-test.config
maxulysse Oct 11, 2024
204c3ee
Template update for nf-core/tools version 3.0.2
nf-core-bot Oct 11, 2024
dd47ec8
Merge branch 'dev' into nf-core-template-merge-3.0.2
maxulysse Oct 11, 2024
96f6366
Merge pull request #1686 from nf-core/nf-core-template-merge-3.0.2
maxulysse Oct 11, 2024
6409a2d
update VEP
maxulysse Oct 23, 2024
abc3ee9
update CHANGELOG
maxulysse Oct 23, 2024
fb9b6ee
Update nf-test.config
maxulysse Oct 23, 2024
404c642
fix flowcell access
FriederikeHanssen Oct 23, 2024
2dbd8a4
update changelog
FriederikeHanssen Oct 23, 2024
100258d
Merge pull request #1678 from maxulysse/nft-utils-0-0-3
maxulysse Oct 23, 2024
c9484dd
Merge branch 'dev' into update_VEP
maxulysse Oct 23, 2024
0303cb2
Update nextflow.config
maxulysse Oct 23, 2024
39c9b8b
Update CHANGELOG.md
maxulysse Oct 23, 2024
955213e
migrate pytest tests to nf-test
maxulysse Oct 23, 2024
0679f72
Merge pull request #1693 from FriederikeHanssen/fix_flowcell
maxulysse Oct 23, 2024
143ac89
Merge branch 'dev' into maxulysse-patch-1
maxulysse Oct 23, 2024
cb535e8
Merge pull request #1694 from nf-core/maxulysse-patch-1
maxulysse Oct 23, 2024
ba60608
fix and update snaps
maxulysse Oct 23, 2024
c429fde
Merge branch 'dev' into update_VEP
maxulysse Oct 23, 2024
e31e930
update to 113
maxulysse Oct 23, 2024
689e88a
update snaps
maxulysse Oct 24, 2024
5c68fda
Merge pull request #1692 from maxulysse/update_VEP
maxulysse Oct 24, 2024
cd7b4c7
update all modules
maxulysse Oct 25, 2024
ee88b37
update CHANGELOG
maxulysse Oct 25, 2024
cb9f74f
validation with lenient mode
maxulysse Oct 25, 2024
2fbb8fa
update schema_input
maxulysse Oct 25, 2024
04b961f
sort inputs
maxulysse Oct 25, 2024
b14e9da
0 without quotes
maxulysse Oct 25, 2024
b739d5a
exclude test
maxulysse Oct 25, 2024
6b430fd
update md5sum
maxulysse Oct 25, 2024
dc30629
update CHANGELOG
maxulysse Oct 25, 2024
36110c3
fix output
maxulysse Oct 27, 2024
6079fcf
fix output
maxulysse Oct 27, 2024
c2bb706
Merge pull request #1695 from maxulysse/update_all
maxulysse Oct 28, 2024
b5fe848
Add nf-test sharding CI (#1668)
edmundmiller Oct 28, 2024
cacfc9a
unhide most parameters
FriederikeHanssen Oct 28, 2024
66b39e1
adding docs from tutorial sarek
lescai Oct 28, 2024
cd56784
moved into subfolder and added oreder to pages
lescai Oct 28, 2024
a7b67c1
Update nf-schema tests that were not failing on lenient mode (#1702)
maxulysse Oct 28, 2024
3d0bdff
subfolders on usage do not work
lescai Oct 28, 2024
d192210
subfolders on usage do not work
lescai Oct 28, 2024
112f472
changed for folder substructure
lescai Oct 28, 2024
1f19db4
updated file names
lescai Oct 28, 2024
b282b15
prettier fix
lescai Oct 28, 2024
0deaece
update json schema
FriederikeHanssen Oct 28, 2024
b5e96f6
clean up schema
FriederikeHanssen Oct 28, 2024
4edc8ab
update icons
FriederikeHanssen Oct 28, 2024
4d2fea0
update changelog
FriederikeHanssen Oct 28, 2024
79b035a
fix typoes
FriederikeHanssen Oct 28, 2024
9e54f08
add missing igneomes ref
FriederikeHanssen Oct 28, 2024
986d5ae
Merge branch 'dev' into issue_976
FriederikeHanssen Oct 28, 2024
5884648
Merge pull request #1707 from FriederikeHanssen/issue_976
FriederikeHanssen Oct 29, 2024
65935d2
Migrate pipeline pytest alignment and annotation tests to nf-test (#1…
maxulysse Oct 29, 2024
b862f0e
Merge pull request #1706 from lescai/dev
lescai Oct 29, 2024
1ba8cee
Remove Strelka tumor-only somatic variant calling (#1709)
nevinwu Oct 29, 2024
db5a429
Fix: Missing import statements on error messages(#1566)
pharmlovex Oct 29, 2024
059b9ed
Update changelog for bug fixes
pharmlovex Oct 29, 2024
823e87b
Prettier formatted files
pharmlovex Oct 29, 2024
e6a6db8
modified changelog to follow sequence
pharmlovex Oct 30, 2024
4087d63
Formatting with prettier
pharmlovex Oct 30, 2024
8ea4af9
Merge pull request #1712 from pharmlovex/dev
pharmlovex Oct 30, 2024
74db9d3
Check if flowcell id matches for paired samples (#1664)
pmoris Oct 30, 2024
15b6cfe
style: Enable harshilAlignment in VS Code workspace
edmundmiller Nov 8, 2024
e362f8f
Merge pull request #1730 from nf-core/harshil-alignment
edmundmiller Nov 9, 2024
79d749e
Don't convert input bam files that are supplied in post-alignment ste…
FriederikeHanssen Nov 12, 2024
5d966a4
add controlfreec test
maxulysse Nov 14, 2024
1f15c87
add tests
maxulysse Nov 14, 2024
1831eb5
update CHANGELOG
maxulysse Nov 14, 2024
fbb686d
remove pytest test
maxulysse Nov 14, 2024
14826cb
remove pytest test
maxulysse Nov 14, 2024
434823a
update nf-test to 9.0.2
maxulysse Nov 14, 2024
600df5b
Migrate strelka pytest to nf-test (#1711)
maxulysse Nov 14, 2024
67a334e
Merge branch 'dev' into controlfreec
maxulysse Nov 14, 2024
e34218c
do not capture this file
maxulysse Nov 14, 2024
31f3c6c
Merge branch 'controlfreec' of github.com:maxulysse/nf-core_sarek int…
maxulysse Nov 14, 2024
cf4f606
no commented tests
maxulysse Nov 15, 2024
0f66cc2
Fix: Convert bcf_annotations.tbi from empty() to value channel to pre…
bounlu Nov 17, 2024
22c7315
Add spring and ubam files to overview pictures (#1734)
FriederikeHanssen Nov 18, 2024
4ebae21
FIX: add setup java 17 (#1743)
maxulysse Dec 4, 2024
8fc4a7b
Fix bug where workflow can hang if the email parameter is set.
robsyme Dec 6, 2024
e68b414
Update CHANGELOG.md
robsyme Dec 6, 2024
9569c93
Merge pull request #1745 from nf-core/oncomplete-fix
FriederikeHanssen Dec 9, 2024
0dfbf14
fix various sentieon module calls
FriederikeHanssen Dec 9, 2024
c842905
Merge branch 'dev' into sentieon
maxulysse Dec 9, 2024
a9a4b7e
Update docs/usage.md
maxulysse Dec 9, 2024
2a08c72
Merge pull request #1579 from nf-core/sentieon
edmundmiller Dec 9, 2024
5508adb
test: Add missing local stubs
edmundmiller Dec 9, 2024
7bdeb11
test(#1380): Add basic stub nf-test
edmundmiller Dec 9, 2024
46a7b08
chore: Patch module
edmundmiller Dec 9, 2024
6ba3416
Update CHANGELOG.md
FriederikeHanssen Dec 9, 2024
427801f
Merge pull request #1746 from FriederikeHanssen/fixsentieon
FriederikeHanssen Dec 10, 2024
1ccf16b
Update docs/usage.md
FriederikeHanssen Dec 10, 2024
2cc694b
Merge branch 'dev' into doc
FriederikeHanssen Dec 10, 2024
abdea49
Merge pull request #1638 from alexanderchang1/master
FriederikeHanssen Dec 10, 2024
20ce551
Merge remote-tracking branch 'upstream/dev' into controlfreec
FriederikeHanssen Dec 10, 2024
2e9581c
Merge branch 'dev' into pl_goleft
FriederikeHanssen Dec 10, 2024
e40d91d
[automated] Fix code linting
nf-core-bot Dec 10, 2024
ed95c83
move entry to correct section
FriederikeHanssen Dec 10, 2024
ae24b7f
Update CHANGELOG.md
FriederikeHanssen Dec 10, 2024
fb5bdbf
Merge pull request #1635 from famosab/doc
FriederikeHanssen Dec 10, 2024
ea11058
update metromap
FriederikeHanssen Dec 10, 2024
041fd87
add paired
FriederikeHanssen Dec 10, 2024
01a4915
add stub tests
FriederikeHanssen Dec 10, 2024
f89dfe8
Merge pull request #1731 from maxulysse/controlfreec
FriederikeHanssen Dec 10, 2024
c50e779
Update docs/usage.md
FriederikeHanssen Dec 10, 2024
30d5520
Merge branch 'dev' into pl_goleft
FriederikeHanssen Dec 10, 2024
eb62596
[automated] Fix code linting
nf-core-bot Dec 10, 2024
8ac90c3
prepare release
FriederikeHanssen Dec 10, 2024
2141330
fix tests, conversion was removed
FriederikeHanssen Dec 10, 2024
532902a
Merge remote-tracking branch 'origin/pl_goleft' into pl_goleft
FriederikeHanssen Dec 10, 2024
ab6ffaa
bump version
FriederikeHanssen Dec 10, 2024
b18c60a
Update docs/usage.md
FriederikeHanssen Dec 10, 2024
b5b2ae2
Update modules/local/samtools/reindex_bam/environment.yml
FriederikeHanssen Dec 10, 2024
a172fbe
bump module version
FriederikeHanssen Dec 10, 2024
d28c92f
Merge remote-tracking branch 'origin/pl_goleft' into pl_goleft
FriederikeHanssen Dec 10, 2024
0b144ff
fix naming
FriederikeHanssen Dec 10, 2024
6f3e673
Merge pull request #1748 from FriederikeHanssen/release_350
FriederikeHanssen Dec 10, 2024
78cfeca
fix subway paths
FriederikeHanssen Dec 10, 2024
6dc5f99
fix channel name
FriederikeHanssen Dec 10, 2024
5c6be78
Merge pull request #1613 from lindenb/pl_goleft
FriederikeHanssen Dec 10, 2024
4fecc5f
update figure
FriederikeHanssen Dec 11, 2024
5335877
remove --max from dcs
FriederikeHanssen Dec 11, 2024
e75cf94
reduce png size
FriederikeHanssen Dec 11, 2024
c2fbec1
Update CHANGELOG.md
FriederikeHanssen Dec 11, 2024
cd59770
Merge pull request #1752 from FriederikeHanssen/fullsize
maxulysse Dec 11, 2024
30da336
fix test string
FriederikeHanssen Dec 11, 2024
85b2de1
update changelog
FriederikeHanssen Dec 11, 2024
b02c77b
Merge pull request #1754 from FriederikeHanssen/fixtest
FriederikeHanssen Dec 11, 2024
ecda5a0
Remove channel and name from local modules
FriederikeHanssen Dec 11, 2024
bee1722
Remove channel and name from local modules
FriederikeHanssen Dec 11, 2024
39c0c8f
Merge pull request #1755 from FriederikeHanssen/localmod
FriederikeHanssen Dec 11, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
12 changes: 6 additions & 6 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ If you'd like to write some code for nf-core/sarek, the standard workflow is as
1. Check that there isn't already an issue about your idea in the [nf-core/sarek issues](https://github.com/nf-core/sarek/issues) to avoid duplicating work. If there isn't one already, please create one so that others know you're working on this
2. [Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the [nf-core/sarek repository](https://github.com/nf-core/sarek) to your GitHub account
3. Make the necessary changes / additions within your forked repository following [Pipeline conventions](#pipeline-contribution-conventions)
4. Use `nf-core schema build` and add any new parameters to the pipeline JSON schema (requires [nf-core tools](https://github.com/nf-core/tools) >= 1.10).
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).
5. Submit a Pull Request against the `dev` branch and wait for the code to be reviewed and merged

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/).
Expand All @@ -40,7 +40,7 @@ There are typically two types of tests that run:
### Lint tests

`nf-core` has a [set of guidelines](https://nf-co.re/developers/guidelines) which all pipelines must adhere to.
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 lint <pipeline-directory>` command.
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.

If any failures or warnings are encountered, please follow the listed URL for more documentation.

Expand Down Expand Up @@ -75,7 +75,7 @@ If you wish to contribute a new step, please use the following coding standards:
2. Write the process block (see below).
3. Define the output channel if needed (see below).
4. Add any new parameters to `nextflow.config` with a default (see below).
5. Add any new parameters to `nextflow_schema.json` with help text (via the `nf-core schema build` tool).
5. Add any new parameters to `nextflow_schema.json` with help text (via the `nf-core pipelines schema build` tool).
6. Add sanity checks and validation for all relevant parameters.
7. Perform local tests to validate that the new code works as expected.
8. If applicable, add a new test command in `.github/workflow/ci.yml`.
Expand All @@ -86,11 +86,11 @@ If you wish to contribute a new step, please use the following coding standards:

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

Once there, use `nf-core schema build` to add to `nextflow_schema.json`.
Once there, use `nf-core pipelines schema build` to add to `nextflow_schema.json`.

### Default processes resource requirements

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/master/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.
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.

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.

Expand All @@ -103,7 +103,7 @@ Please use the following naming schemes, to make it easy to understand what is g

### Nextflow version bumping

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 bump-version --nextflow . [min-nf-version]`
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]`

### Images and figures

Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/sare
- [ ] If you've fixed a bug or added code that should be tested, add tests!
- [ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](https://github.com/nf-core/sarek/tree/master/.github/CONTRIBUTING.md)
- [ ] If necessary, also make a PR on the nf-core/sarek _branch_ on the [nf-core/test-datasets](https://github.com/nf-core/test-datasets) repository.
- [ ] Make sure your code lints (`nf-core lint`).
- [ ] Make sure your code lints (`nf-core pipelines lint`).
- [ ] Ensure the test suite passes (`nextflow run . -profile test,docker --outdir <OUTDIR>`).
- [ ] Check for unexpected warnings in debug mode (`nextflow run . -profile debug,test,docker --outdir <OUTDIR>`).
- [ ] Usage Documentation in `docs/usage.md` is updated.
Expand Down
50 changes: 50 additions & 0 deletions .github/nf-test-tags.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
exclude:
- tags: "bcftools/annotate"
- tags: "bcftools/concat"
- tags: "bcftools/mpileup"
- tags: "bcftools/sort"
- tags: "bwa/index"
- tags: "bwa/mem"
- tags: "bwamem2/index"
- tags: "bwamem2/mem"
- tags: "cat/cat"
- tags: "cat/fastq"
- tags: "cnvkit/antitarget"
- tags: "cnvkit/batch"
- tags: "cnvkit/reference"
- tags: "deepvariant"
- tags: "dragmap/align"
- tags: "dragmap/hashtable"
- tags: "ensemblvep/download"
- tags: "ensemblvep/vep"
- tags: "fastp"
- tags: "fastqc"
- tags: "fgbio/fastqtobam"
- tags: "freebayes"
- tags: "gatk4/applybqsr"
- tags: "gatk4/baserecalibrator"
- tags: "gatk4/estimatelibrarycomplexity"
- tags: "gatk4/genomicsdbimport"
- tags: "gatk4/haplotypecaller"
- tags: "gatk4/markduplicates"
- tags: "gatk4/mergevcfs"
- tags: "gatk4/mutect2"
- tags: "gatk4spark/applybqsr"
- tags: "gatk4spark/markduplicates"
- tags: "gawk"
- tags: "lofreq/callparallel"
- tags: "mosdepth"
- tags: "multiqc"
- tags: "ngscheckmate/ncm"
- tags: "samblaster"
- tags: "samtools/convert"
- tags: "samtools/mpileup"
- tags: "samtools/stats"
- tags: "snpeff/snpeff"
- tags: "strelka/germline"
- tags: "strelka/somatic"
- tags: "subworkflows/utils_nfvalidation_plugin"
- tags: "tabix/bgziptabix"
- tags: "tabix/tabix"
- tags: "tiddit/sv"
- tags: "untar"
Loading
Loading