Skip to content
Closed
Show file tree
Hide file tree
Changes from 250 commits
Commits
Show all changes
2632 commits
Select commit Hold shift + click to select a range
0150003
update skip_markduplicates tests
maxulysse Jul 17, 2022
f1453a3
fix mosdepth
maxulysse Jul 17, 2022
e053000
update umi checksums
FriederikeHanssen Jul 17, 2022
0e40b6a
no need to overwrite the dragmap prefix, it is the same
FriederikeHanssen Jul 17, 2022
eb07bf0
remove checksum for collated bam file
FriederikeHanssen Jul 17, 2022
fb1e756
if reference is provided then no bed file
FriederikeHanssen Jul 17, 2022
440d2f9
have freebayes only use a single core, parallel implementation isn't …
FriederikeHanssen Jul 17, 2022
85afefc
add warn if intervals is provided without wes
FriederikeHanssen Jul 17, 2022
62e182e
combine conditionals
FriederikeHanssen Jul 17, 2022
1411796
fix pon validation
FriederikeHanssen Jul 17, 2022
e8d484f
Merge pull request #614 from WackerO/umi
FriederikeHanssen Jul 17, 2022
5dc3f3b
Merge pull request #646 from FriederikeHanssen/params
maxulysse Jul 17, 2022
442d9b5
Merge remote-tracking branch 'upstream/dev' into dev_modules_update
maxulysse Jul 17, 2022
8b9183d
Merge remote-tracking branch 'upstream/dev' into 3.0
maxulysse Jul 17, 2022
9194d97
fix output
maxulysse Jul 17, 2022
3e7bdd8
fix output
maxulysse Jul 17, 2022
5b83a5d
Merge pull request #633 from maxulysse/dev_modules_update
maxulysse Jul 17, 2022
f4055c8
Merge remote-tracking branch 'upstream/dev' into 3.0
maxulysse Jul 17, 2022
770881c
update aligner tests expected files
maxulysse Jul 17, 2022
7600d62
Add vague statement about md and bqsr
FriederikeHanssen Jul 17, 2022
3f1002e
Add comments about bwa parameters
FriederikeHanssen Jul 17, 2022
0064a9c
add comment on empty snpeff plots in multiqc
FriederikeHanssen Jul 17, 2022
45aab1c
Merge pull request #648 from FriederikeHanssen/param_valid
maxulysse Jul 18, 2022
ee4b556
Merge remote-tracking branch 'upstream/dev' into dev_tests_yml
maxulysse Jul 18, 2022
4ecd84e
fix output for targete bed
maxulysse Jul 18, 2022
c39047a
code polish
maxulysse Jul 18, 2022
889768d
fix expected outputs
maxulysse Jul 18, 2022
ad44d81
fix typo
maxulysse Jul 18, 2022
4f6d0cc
update annotation tests
maxulysse Jul 18, 2022
61e71d6
fix intervals checks
maxulysse Jul 18, 2022
34757e8
no params.intervals for no_intervals tests...
maxulysse Jul 18, 2022
abe5b3e
update CHANGELOG
maxulysse Jul 18, 2022
0b89443
update alignment_to_fastq tests
maxulysse Jul 18, 2022
641351d
merge upstream/dev
FriederikeHanssen Jul 18, 2022
3a30bd9
sort contributors
FriederikeHanssen Jul 18, 2022
7031b11
update default tests expected files
maxulysse Jul 18, 2022
6f481bb
fix typo
maxulysse Jul 18, 2022
51a1c6a
comment table back in so we can see how it looks like on the website
FriederikeHanssen Jul 18, 2022
4693f95
update gatk_spark tests
maxulysse Jul 18, 2022
42bb953
Extracted TIDDIT from pairVC into a subworkflow
WackerO Jul 18, 2022
2e512cd
no need for index there
maxulysse Jul 18, 2022
0261cd0
Merge remote-tracking branch 'upstream/dev' into 3.0
maxulysse Jul 18, 2022
c43ef33
Merge pull request #650 from maxulysse/dev_intervals_checks
FriederikeHanssen Jul 18, 2022
7b7ca59
Update docs/output.md
FriederikeHanssen Jul 18, 2022
e91de85
Update docs/output.md
FriederikeHanssen Jul 18, 2022
9be87c4
Update docs/output.md
FriederikeHanssen Jul 18, 2022
fbb9127
Update docs/output.md
FriederikeHanssen Jul 18, 2022
2faab0c
Update docs/output.md
FriederikeHanssen Jul 18, 2022
ad5675d
Update docs/output.md
FriederikeHanssen Jul 18, 2022
a5117b2
Update docs/output.md
FriederikeHanssen Jul 18, 2022
b44fe1f
Update docs/output.md
FriederikeHanssen Jul 18, 2022
5b927a6
Update docs/output.md
FriederikeHanssen Jul 18, 2022
4b011e9
add margin back in
FriederikeHanssen Jul 18, 2022
82ebe4e
Updated changelog
WackerO Jul 18, 2022
33e27bf
Merge remote-tracking branch 'upstream/dev' into tutorials
FriederikeHanssen Jul 18, 2022
48bd772
add qc header
FriederikeHanssen Jul 18, 2022
82b39f4
Merge remote-tracking branch 'upstream/dev' into dev_tests_yml
maxulysse Jul 18, 2022
7a07ca0
removing strelka from markduplicates tests
maxulysse Jul 18, 2022
813a5cb
Merge remote-tracking branch 'upstream/dev' into 3.0
maxulysse Jul 18, 2022
90d0fd8
Update docs/output.md
FriederikeHanssen Jul 18, 2022
f428365
Update docs/output.md
FriederikeHanssen Jul 18, 2022
ac22900
merge upstream/dev
FriederikeHanssen Jul 18, 2022
c9103a3
accidentally removed split_fastq saving
FriederikeHanssen Jul 18, 2022
585083b
add full size tests somatic
ggabernet Jul 18, 2022
e6be47c
update changelog
ggabernet Jul 18, 2022
4bb9dee
Update nextflow_schema.json
FriederikeHanssen Jul 18, 2022
4dda568
apply review comments
FriederikeHanssen Jul 18, 2022
ecc28fe
Update docs/output.md
FriederikeHanssen Jul 18, 2022
8b10dc9
apply review comments
FriederikeHanssen Jul 18, 2022
d98205d
actually index is needed, but not always
maxulysse Jul 18, 2022
7a131d2
Update docs/output.md
FriederikeHanssen Jul 18, 2022
d3de897
Update docs/output.md
FriederikeHanssen Jul 18, 2022
e751605
object to text
FriederikeHanssen Jul 18, 2022
0c11aab
update markduplicates tests
maxulysse Jul 18, 2022
5c67a8f
update only paired VC tests
maxulysse Jul 18, 2022
d50e27b
update only paired variantcalling tests
maxulysse Jul 18, 2022
3e99d7f
catch WARN messages
maxulysse Jul 18, 2022
64ce0a6
fix fastqc output tests
maxulysse Jul 18, 2022
35f518c
improve test_pair and test_prepare_recalibration
maxulysse Jul 18, 2022
7d1ca3a
another try at getting the svg right
FriederikeHanssen Jul 18, 2022
2614122
Merge pull request #642 from FriederikeHanssen/ref_files
FriederikeHanssen Jul 18, 2022
9fa8683
Update docs/output.md
FriederikeHanssen Jul 18, 2022
af74035
Update docs/output.md
FriederikeHanssen Jul 18, 2022
2026c62
Update docs/output.md
FriederikeHanssen Jul 18, 2022
0822017
Update docs/output.md
FriederikeHanssen Jul 18, 2022
54f8c84
Update docs/output.md
FriederikeHanssen Jul 18, 2022
95696f6
Update docs/output.md
FriederikeHanssen Jul 18, 2022
296c80e
Update docs/output.md
FriederikeHanssen Jul 18, 2022
f872f96
Update docs/output.md
FriederikeHanssen Jul 18, 2022
959449f
Update docs/output.md
FriederikeHanssen Jul 18, 2022
9765f37
Update docs/output.md
FriederikeHanssen Jul 18, 2022
2f1cfc2
Update docs/output.md
FriederikeHanssen Jul 18, 2022
e445ab9
Update docs/output.md
FriederikeHanssen Jul 18, 2022
5cc96ae
Update docs/output.md
FriederikeHanssen Jul 18, 2022
6ba40c9
Update docs/output.md
FriederikeHanssen Jul 18, 2022
47c4f41
Update docs/output.md
FriederikeHanssen Jul 18, 2022
18ea0e1
Update docs/output.md
FriederikeHanssen Jul 18, 2022
078cdec
Update docs/output.md
FriederikeHanssen Jul 18, 2022
cfde050
Apply suggestions from code review
FriederikeHanssen Jul 18, 2022
bcd5408
add review comments
FriederikeHanssen Jul 18, 2022
b91f7c2
Merge remote-tracking branch 'origin/tutorials' into tutorials
FriederikeHanssen Jul 18, 2022
f6700ca
gvcf everywhere
FriederikeHanssen Jul 18, 2022
2e82eeb
add mosdepth name change
FriederikeHanssen Jul 18, 2022
58a5574
merge upstream/dev
FriederikeHanssen Jul 18, 2022
282077c
unify font size in png as well
FriederikeHanssen Jul 18, 2022
fe4b7aa
mavenpro font
FriederikeHanssen Jul 18, 2022
096a30c
mavenpro font
FriederikeHanssen Jul 18, 2022
28f6866
success
FriederikeHanssen Jul 18, 2022
033b1be
Update docs/output.md
FriederikeHanssen Jul 18, 2022
ddd67e2
Update docs/output.md
FriederikeHanssen Jul 18, 2022
f89636c
add 3.0 to svg
FriederikeHanssen Jul 18, 2022
3354619
Merge remote-tracking branch 'origin/tutorials' into tutorials
FriederikeHanssen Jul 18, 2022
74e970b
Update workflows/sarek.nf
FriederikeHanssen Jul 18, 2022
94ccbc0
fix typo
maxulysse Jul 18, 2022
49d3eca
update recalibrate tests
maxulysse Jul 18, 2022
6a35a19
Apply suggestions from code review
FriederikeHanssen Jul 18, 2022
afdcd40
update save output bam and bam mapped tests
maxulysse Jul 18, 2022
5d256c2
check for mapping step
FriederikeHanssen Jul 18, 2022
59ea24e
check for mapping step
FriederikeHanssen Jul 18, 2022
324218b
Merge pull request #610 from FriederikeHanssen/tutorials
FriederikeHanssen Jul 18, 2022
c488ed3
stash
maxulysse Jul 18, 2022
f33ac8e
implement review comments
ggabernet Jul 18, 2022
07e4169
separate somatic GHA workflow
ggabernet Jul 18, 2022
c46372b
Merge remote-tracking branch 'upstream/dev' into dev_tests_yml
maxulysse Jul 18, 2022
b1068e3
Merge remote-tracking branch 'upstream/dev' into 3.0
maxulysse Jul 18, 2022
b57db9a
change results folder structure
FriederikeHanssen Jul 18, 2022
93b241b
forgot conflicts
maxulysse Jul 18, 2022
e42b281
merge upstream/dev
FriederikeHanssen Jul 18, 2022
3b576c1
update changelog & docs
FriederikeHanssen Jul 18, 2022
e9a3362
why 2 bams in single_bam?
maxulysse Jul 18, 2022
68f61ae
update CHANGELOG
maxulysse Jul 18, 2022
eec5eb0
channel magic for skip or not markduplicates
maxulysse Jul 18, 2022
2b034da
Allow any step but annotation to start from bam-files
asp8200 Jul 18, 2022
9afe650
Merge pull request #652 from ggabernet/dev
ggabernet Jul 18, 2022
20db917
fix tests
maxulysse Jul 18, 2022
ef7f9cb
Merge remote-tracking branch 'upstream/dev' into file_structure
FriederikeHanssen Jul 18, 2022
570a357
update paths in test files
FriederikeHanssen Jul 18, 2022
e4a2ab1
improve csv creation when skipping markduplicates + update tests
maxulysse Jul 18, 2022
82e32d1
fix paths
maxulysse Jul 18, 2022
934a0dd
fix logic
maxulysse Jul 18, 2022
0bf6676
Merge pull request #653 from FriederikeHanssen/file_structure
FriederikeHanssen Jul 18, 2022
93be3b0
Merge branch 'dev' into adjust_checks_step_plus_csv
asp8200 Jul 18, 2022
783b4d2
Updating changelog
asp8200 Jul 18, 2022
9be3c5c
Removing redundant blank line
asp8200 Jul 18, 2022
91bbf3d
own subworkflow for cnvkit references
FriederikeHanssen Jul 18, 2022
46cc19c
add comment back in
FriederikeHanssen Jul 18, 2022
3a0d841
Merge pull request #654 from asp8200/adjust_checks_step_plus_csv
apeltzer Jul 18, 2022
fd48c58
why does this work
FriederikeHanssen Jul 18, 2022
2e65182
this works aside from versions parsing
FriederikeHanssen Jul 18, 2022
94114da
try with only one version
FriederikeHanssen Jul 18, 2022
0b554f9
no versions
FriederikeHanssen Jul 18, 2022
3653b9e
fix skip_qc tests
maxulysse Jul 19, 2022
e7a3aad
Merge remote-tracking branch 'upstream/dev' into dev_tests_yml
maxulysse Jul 19, 2022
7c3bcfc
Merge remote-tracking branch 'upstream/dev' into 3.0
maxulysse Jul 19, 2022
e433dda
Copied the tiddit subworkflow modifications from other branch
WackerO Jul 19, 2022
ecd1196
Removed tabix
WackerO Jul 19, 2022
fcc7137
versioning makes it fail
FriederikeHanssen Jul 19, 2022
98cc11e
update more tests
maxulysse Jul 19, 2022
5496c61
try leveling everything up
FriederikeHanssen Jul 19, 2022
b0e4873
Merge pull request #656 from FriederikeHanssen/docs_format
FriederikeHanssen Jul 19, 2022
b71b726
fix path after merging
maxulysse Jul 19, 2022
d8946a0
tiddit now has a subworkflow
WackerO Jul 19, 2022
4e04c9b
Merge branch 'dev' of https://github.com/nf-core/sarek into tiddit_sw
WackerO Jul 19, 2022
988a4af
Restored modules
WackerO Jul 19, 2022
d009837
Bugfixing
WackerO Jul 19, 2022
3c51b13
fix names fastqc [skip_actions]
SusiJo Jul 19, 2022
9f6ee7b
resources that worked for matched ICGC WGS data
FriederikeHanssen Jul 19, 2022
1fcd53e
reduce resource requests in local modules
FriederikeHanssen Jul 19, 2022
e91c85b
fix naming
FriederikeHanssen Jul 19, 2022
ba1096a
update changelog
FriederikeHanssen Jul 19, 2022
e706b6b
merge upstream/dev
FriederikeHanssen Jul 19, 2022
c7c4d27
also add some docs on the resource requests
FriederikeHanssen Jul 19, 2022
45953be
Update conf/modules.config
WackerO Jul 19, 2022
f8eb887
add docu stuff
SusiJo Jul 19, 2022
edefe71
Merge remote-tracking branch 'upstream/dev' into intervals_fasta
FriederikeHanssen Jul 19, 2022
e840cdb
Still bugfixing
WackerO Jul 19, 2022
7b252d9
Should work now(?)
WackerO Jul 19, 2022
65acf3c
update ascat docu on wes
SusiJo Jul 19, 2022
0d8d4b8
correct subscript
SusiJo Jul 19, 2022
70f27cd
fix typo + update changelog
SusiJo Jul 19, 2022
2e648d2
fix changelog numbering
SusiJo Jul 19, 2022
b668ca2
this works now but without versions
FriederikeHanssen Jul 19, 2022
c6b748e
add test for this
FriederikeHanssen Jul 19, 2022
5bdfd48
rm line
SusiJo Jul 19, 2022
2ac8490
versions computation works, but collection fails
FriederikeHanssen Jul 19, 2022
d840af4
Merge pull request #651 from WackerO/tiddit_sw
WackerO Jul 19, 2022
980f76b
Update workflows/sarek.nf
FriederikeHanssen Jul 19, 2022
1400e2b
update all tools tests
maxulysse Jul 19, 2022
700b30d
Merge remote-tracking branch 'upstream/dev' into dev_tests_yml
maxulysse Jul 19, 2022
5556e57
Merge remote-tracking branch 'upstream/dev' into 3.0
maxulysse Jul 19, 2022
433ef65
Merge branch '3.0' of github.com:maxulysse/nf-core_sarek into 3.0
maxulysse Jul 19, 2022
1e043d3
Merge pull request #647 from FriederikeHanssen/resource_labels
maxulysse Jul 19, 2022
374f2ea
Merge pull request #659 from SusiJo/ascat_docu
maxulysse Jul 19, 2022
a958da4
Update README.md
FriederikeHanssen Jul 19, 2022
e5b6131
fix mpileup tests
maxulysse Jul 19, 2022
089dc55
Merge remote-tracking branch 'upstream/dev' into dev_tests_yml
maxulysse Jul 19, 2022
a1b3e0a
fix cnvkit
maxulysse Jul 19, 2022
35d2911
Merge pull request #658 from SusiJo/fix_names_multiqc
FriederikeHanssen Jul 19, 2022
0c0a83e
Update README.md
FriederikeHanssen Jul 19, 2022
bb9a013
Update README.md
FriederikeHanssen Jul 19, 2022
3142264
Update docs/usage.md
FriederikeHanssen Jul 19, 2022
0264d84
Apply suggestions from code review
FriederikeHanssen Jul 19, 2022
e029519
Merge pull request #649 from maxulysse/dev_tests_yml
FriederikeHanssen Jul 19, 2022
b515bd3
merge upstream/dev
FriederikeHanssen Jul 19, 2022
2cdb747
somehow parts of the bedfile end up in the collate_versions.yml
FriederikeHanssen Jul 19, 2022
70a559d
add cnvkit index
FriederikeHanssen Jul 19, 2022
84f8586
update changelog
FriederikeHanssen Jul 19, 2022
1722ff4
more versiosn test
FriederikeHanssen Jul 19, 2022
ab2142f
bad copy&paste was the culprit
FriederikeHanssen Jul 19, 2022
c5ab1a1
separate ascat and controlfreec ploidy
FriederikeHanssen Jul 19, 2022
ea17f5d
add params to schema
FriederikeHanssen Jul 19, 2022
8b515c8
named output
FriederikeHanssen Jul 19, 2022
a1e52e3
use correct subworkflow
FriederikeHanssen Jul 19, 2022
5271e35
Merge remote-tracking branch 'upstream/dev' into 3.0
maxulysse Jul 20, 2022
b58ca44
Merge branch '3.0' of github.com:maxulysse/nf-core_sarek into 3.0
maxulysse Jul 20, 2022
e5a4ffb
Merge pull request #663 from FriederikeHanssen/ascat_controlfreec_ploidy
maxulysse Jul 20, 2022
ab7b1fb
convert to text
FriederikeHanssen Jul 20, 2022
11c1842
Merge branch '3.0' into dev
maxulysse Jul 20, 2022
4d2a1c5
use new container
FriederikeHanssen Jul 20, 2022
f9f8a4e
add split fastq to test full
ggabernet Jul 20, 2022
cbe9755
simplify multiqc_config channel
SusiJo Jul 20, 2022
6165cb3
update mem bwa mem
ggabernet Jul 20, 2022
d83794f
Merge remote-tracking branch 'origin/dev' into multiqc_channels
SusiJo Jul 20, 2022
25d2c10
Merge remote-tracking branch 'upstream/dev' into 3.0
maxulysse Jul 20, 2022
714214c
Update tests/test_targeted.yml
FriederikeHanssen Jul 20, 2022
7082782
remove task.ext.args that is not used in local module
FriederikeHanssen Jul 20, 2022
2fd6afd
Merge branch 'dev' into index_svg
maxulysse Jul 20, 2022
081f8e2
Updated SVDB module
WackerO Jul 20, 2022
c43ea10
Merge branch 'dev' of https://github.com/nf-core/sarek into svdb
WackerO Jul 20, 2022
d1402dd
Merge pull request #666 from SusiJo/multiqc_channels
maxulysse Jul 20, 2022
3720676
Merge pull request #655 from FriederikeHanssen/intervals_fasta
maxulysse Jul 20, 2022
da917e1
Update conf/modules.config
WackerO Jul 20, 2022
08f130b
Merge pull request #665 from ggabernet/fulltests
maxulysse Jul 20, 2022
c48b7f1
Update conf/modules.config
WackerO Jul 20, 2022
93a4925
Merge pull request #661 from FriederikeHanssen/index_svg
FriederikeHanssen Jul 20, 2022
c064aee
Merge remote-tracking branch 'upstream/dev' into 3.0
maxulysse Jul 20, 2022
db7024e
Merge branch '3.0' into dev_3.0_PR
maxulysse Jul 20, 2022
da6cfc9
Updated module again
WackerO Jul 20, 2022
d47bb26
Merge branch 'dev' of https://github.com/nf-core/sarek into svdb
WackerO Jul 20, 2022
ba020b3
Merge branch 'svdb' of https://github.com/WackerO/sarek into svdb
WackerO Jul 20, 2022
fc50739
remove duplication
maxulysse Jul 20, 2022
335396a
fix path to file in csv files
maxulysse Jul 20, 2022
a36e697
update CHANGELOG
maxulysse Jul 20, 2022
fc09504
Apply suggestions from code review
maxulysse Jul 20, 2022
b1ce5bb
Updated test
WackerO Jul 20, 2022
cff880f
Merge pull request #669 from maxulysse/dev_restart_csv
maxulysse Jul 20, 2022
23453e8
Merge remote-tracking branch 'upstream/dev' into 3.0
maxulysse Jul 20, 2022
467b2e6
Merge pull request #664 from maxulysse/dev_3.0_PR
maxulysse Jul 20, 2022
3441df4
Merge pull request #667 from WackerO/svdb
maxulysse Jul 20, 2022
b9a891c
Merge remote-tracking branch 'upstream/dev' into 3.0
maxulysse Jul 20, 2022
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
  •  
  •  
  •  
109 changes: 0 additions & 109 deletions .circleci/config.yml

This file was deleted.

24 changes: 24 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_size = 4
indent_style = space

[*.{md,yml,yaml,html,css,scss,js}]
indent_size = 2

# These files are edited and tested upstream in nf-core/modules
[/modules/nf-core/**]
charset = unset
end_of_line = unset
insert_final_newline = unset
trim_trailing_whitespace = unset
indent_style = unset
indent_size = unset

[/assets/email*]
indent_size = unset
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
*.config linguist-language=nextflow
modules/nf-core/** linguist-generated
subworkflows/nf-core/** linguist-generated
3 changes: 2 additions & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
* @MaxUlysse
* @FriederikeHanssen
* @maxulysse
55 changes: 15 additions & 40 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,10 @@ Contributions to the code are even more welcome ;)

If you'd like to write some code for nf-core/sarek, the standard workflow is as follows:

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
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 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 Down Expand Up @@ -49,9 +48,9 @@ These tests are run both with the latest available version of `Nextflow` and als

:warning: Only in the unlikely and regretful event of a release happening with a bug.

* On your own fork, make a new branch `patch` based on `upstream/master`.
* Fix the bug, and bump version (X.Y.Z+1).
* A PR should be made on `master` from patch to directly this particular bug.
- On your own fork, make a new branch `patch` based on `upstream/master`.
- Fix the bug, and bump version (X.Y.Z+1).
- A PR should be made on `master` from patch to directly this particular bug.

## Getting help

Expand All @@ -68,22 +67,19 @@ If you wish to contribute a new step, please use the following coding standards:
1. Define the corresponding input channel into your new process from the expected previous process channel
2. Write the process block (see below).
3. Define the output channel if needed (see below).
4. Add any new flags/options to `nextflow.config` with a default (see below).
5. Add any new flags/options to `nextflow_schema.json` with help text (with `nf-core schema build .`).
6. Add any new flags/options to the help message (for integer/text parameters, print to help the corresponding `nextflow.config` parameter).
7. Add sanity checks for all relevant parameters.
8. Add any new software to the `scrape_software_versions.py` script in `bin/` and the version command to the `scrape_software_versions` process in `main.nf`.
9. Do local tests that the new code works properly and as expected.
10. Add a new test command in `.github/workflow/ci.yaml`.
11. If applicable add a [MultiQC](https://https://multiqc.info/) module.
12. Update MultiQC config `assets/multiqc_config.yaml` so relevant suffixes, name clean up, General Statistics Table column order, and module figures are in the right order.
13. Optional: Add any descriptions of MultiQC report sections and output files to `docs/output.md`.
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).
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`.
9. Update MultiQC config `assets/multiqc_config.yml` so relevant suffixes, file name clean up and module plots are in the appropriate order. If applicable, add a [MultiQC](https://https://multiqc.info/) module.
10. Add a description of the output files and if relevant any appropriate images from the MultiQC report to `docs/output.md`.

### Default values

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 schema build` to add to `nextflow_schema.json`.

### Default processes resource requirements

Expand All @@ -95,34 +91,13 @@ The process resources can be passed on to the tool dynamically within the proces

Please use the following naming schemes, to make it easy to understand what is going where.

* initial process channel: `ch_output_from_<process>`
* intermediate and terminal channels: `ch_<previousprocess>_for_<nextprocess>`
- initial process channel: `ch_output_from_<process>`
- intermediate and terminal channels: `ch_<previousprocess>_for_<nextprocess>`

### 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]`

### Software version reporting

If you add a new tool to the pipeline, please ensure you add the information of the tool to the `get_software_version` process.

Add to the script block of the process, something like the following:

```bash
<YOUR_TOOL> --version &> v_<YOUR_TOOL>.txt 2>&1 || true
```

or

```bash
<YOUR_TOOL> --help | head -n 1 &> v_<YOUR_TOOL>.txt 2>&1 || true
```

You then need to edit the script `bin/scrape_software_versions.py` to:

1. Add a Python regex for your tool's `--version` output (as in stored in the `v_<YOUR_TOOL>.txt` file), to ensure the version is reported as a `v` and the version number e.g. `v2.1.1`
2. Add a HTML entry to the `OrderedDict` for formatting in MultiQC.

### Images and figures

For overview images and other documents we follow the nf-core [style guidelines and examples](https://nf-co.re/developers/design_guidelines).
66 changes: 0 additions & 66 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Bug report
description: Report something that is broken or incorrect
labels: bug
body:
- type: markdown
attributes:
value: |
Before you post this issue, please check the documentation:

- [nf-core website: troubleshooting](https://nf-co.re/usage/troubleshooting)
- [nf-core/sarek pipeline documentation](https://nf-co.re/sarek/usage)

- type: textarea
id: description
attributes:
label: Description of the bug
description: A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
id: command_used
attributes:
label: Command used and terminal output
description: Steps to reproduce the behaviour. Please paste the command you used to launch the pipeline and the output from your terminal.
render: console
placeholder: |
$ nextflow run ...

Some output where something broke

- type: textarea
id: files
attributes:
label: Relevant files
description: |
Please drag and drop the relevant files here. Create a `.zip` archive if the extension is not allowed.
Your verbose log file `.nextflow.log` is often useful _(this is a hidden file in the directory where you launched the pipeline)_ as well as custom Nextflow configuration files.

- type: textarea
id: system
attributes:
label: System information
description: |
* Nextflow version _(eg. 21.10.3)_
* Hardware _(eg. HPC, Desktop, Cloud)_
* Executor _(eg. slurm, local, awsbatch)_
* Container engine: _(e.g. Docker, Singularity, Conda, Podman, Shifter or Charliecloud)_
* OS _(eg. CentOS Linux, macOS, Linux Mint)_
* Version of nf-core/sarek _(eg. 1.1, 1.5, 1.8.2)_
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
blank_issues_enabled: false
contact_links:
- name: Join nf-core
url: https://nf-co.re/join
Expand Down
34 changes: 0 additions & 34 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

Loading