Skip to content
Merged
Show file tree
Hide file tree
Changes from 250 commits
Commits
Show all changes
2793 commits
Select commit Hold shift + click to select a range
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
0ea9747
fix no_intervals and tests
Jul 18, 2022
68f61ae
update CHANGELOG
maxulysse Jul 18, 2022
0717286
lint
Jul 18, 2022
37e5e77
update to dev
Jul 18, 2022
eec5eb0
channel magic for skip or not markduplicates
maxulysse Jul 18, 2022
1db8bc8
lint
Jul 18, 2022
ff6b530
fix empty module
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
aa7127a
correct prepare_genome input
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
5be916a
merge with dev
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
21182a3
change name to match tests
nickhsmith 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
9eebd71
update test
nickhsmith Jul 19, 2022
69feebd
Update workflows/sarek.nf
nickhsmith Jul 19, 2022
20a7e2e
Update workflows/sarek.nf
nickhsmith Jul 19, 2022
3cbe260
Apply suggestions from code review
nickhsmith Jul 19, 2022
e9fb076
Update conf/modules.config
nickhsmith Jul 19, 2022
6ea35cc
Update subworkflows/nf-core/variantcalling/haplotypecaller/main.nf
nickhsmith Jul 19, 2022
8d7235d
Update conf/modules.config
nickhsmith Jul 19, 2022
13f9bd7
Update nextflow_schema.json
nickhsmith Jul 19, 2022
e75a7f3
remove unneeded when statements
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
fb7c594
update paths
nickhsmith Jul 19, 2022
04b3191
Merge branch 'vqsr' of github.com:nickhsmith/sarek into vqsr
nickhsmith Jul 19, 2022
9e31397
fix warnings
nickhsmith Jul 19, 2022
c7c4d27
also add some docs on the resource requests
FriederikeHanssen Jul 19, 2022
fc0c251
fix warnings
nickhsmith Jul 19, 2022
2e9a724
update path
nickhsmith 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
748947d
remove lane from csv
nickhsmith 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
7e3a11e
add step_variant calling
nickhsmith 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
8db1809
comment nextflow config, meta map readability, add ch_ prefix, remove…
FriederikeHanssen 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
77eb3d6
Update conf/modules.config
nickhsmith Jul 19, 2022
3fe7927
Update conf/modules.config
nickhsmith Jul 19, 2022
acb9fce
Update modules.config
nickhsmith Jul 19, 2022
c793d5f
Merge remote-tracking branch 'NF-core/dev' into vqsr
Jul 19, 2022
15949f5
Add missing , after refactor
FriederikeHanssen Jul 19, 2022
a1b3e0a
fix cnvkit
maxulysse Jul 19, 2022
35d2911
Merge pull request #658 from SusiJo/fix_names_multiqc
FriederikeHanssen Jul 19, 2022
46b7c2c
also indent the meta values for prettiness
FriederikeHanssen Jul 19, 2022
763f85d
remove individual subworkflow tests for now
FriederikeHanssen Jul 19, 2022
0902fa0
add split() to all tools calls
FriederikeHanssen Jul 19, 2022
46ff17e
fix syntax
FriederikeHanssen Jul 19, 2022
6e6d352
remove local subworkflow testing since it is ot run
FriederikeHanssen Jul 19, 2022
68498a1
indents
FriederikeHanssen Jul 19, 2022
b51279b
indent subworkflow calls more consistently
FriederikeHanssen Jul 19, 2022
3b8d92e
add more line breaks & clarify magic booleans
FriederikeHanssen Jul 19, 2022
0c0a83e
Update README.md
FriederikeHanssen Jul 19, 2022
bb9a013
Update README.md
FriederikeHanssen Jul 19, 2022
c4e8a39
remove unneeded vep_cache version
FriederikeHanssen Jul 19, 2022
3142264
Update docs/usage.md
FriederikeHanssen Jul 19, 2022
0264d84
Apply suggestions from code review
FriederikeHanssen Jul 19, 2022
b0024ef
remove genome, using default
FriederikeHanssen Jul 19, 2022
d55d37d
formatting
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
2b20ebf
merge upstream/dev
FriederikeHanssen Jul 19, 2022
ab2142f
bad copy&paste was the culprit
FriederikeHanssen Jul 19, 2022
0614420
update with zipped indices
FriederikeHanssen Jul 19, 2022
02593a8
update changelog
FriederikeHanssen Jul 19, 2022
13b71d8
fix channel naming after merge
FriederikeHanssen Jul 19, 2022
be4b2a3
remove trimgalore wf, we are not using it anymore
FriederikeHanssen Jul 19, 2022
c5ab1a1
separate ascat and controlfreec ploidy
FriederikeHanssen Jul 19, 2022
ea17f5d
add params to schema
FriederikeHanssen Jul 19, 2022
fb0278f
add refactor deleted channel back
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
87f3405
Apply suggestions from code review
nickhsmith Jul 20, 2022
729bf7c
tbi
FriederikeHanssen Jul 20, 2022
e5a4ffb
Merge pull request #663 from FriederikeHanssen/ascat_controlfreec_ploidy
maxulysse Jul 20, 2022
ef8f526
Apply suggestions from code review
nickhsmith Jul 20, 2022
72b4bc8
hg19 sample names
Jul 20, 2022
ab7b1fb
convert to text
FriederikeHanssen Jul 20, 2022
e5b1703
change tool inputs
Jul 20, 2022
d6c006e
Merge branch 'vqsr' of github.com:nickhsmith/sarek into vqsr
Jul 20, 2022
6db5d6d
remove comments
maxulysse 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
c94e00b
Update subworkflows/nf-core/variantcalling/haplotypecaller/main.nf
nickhsmith 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
b6cb7d3
add info about VEP plugins
maxulysse Jul 20, 2022
0dd0976
Update after code review
Jul 20, 2022
717e271
groupTuple
Jul 20, 2022
da17db9
merge with dev
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
c2f84dd
Merge remote-tracking branch 'upstream/dev' into dev_annotation_docs
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
039f236
merge upstream/dev
FriederikeHanssen Jul 20, 2022
0a65271
sort meta fields alphabetically where missing
FriederikeHanssen Jul 20, 2022
fc50739
remove duplication
maxulysse Jul 20, 2022
d73b835
sort meta fields alphabetically where missing
FriederikeHanssen Jul 20, 2022
28e88fa
harmonize tiddit file structure
FriederikeHanssen Jul 20, 2022
335396a
fix path to file in csv files
maxulysse Jul 20, 2022
a36e697
update CHANGELOG
maxulysse Jul 20, 2022
1168ed9
fix schema_ignore_params usage and issue with vep and snpeff versions
maxulysse Jul 20, 2022
3a46587
update CHANGELOG
maxulysse Jul 20, 2022
47bdd0c
update docs
maxulysse Jul 20, 2022
153bcd0
address umi concerns & docs
FriederikeHanssen Jul 20, 2022
fc09504
Apply suggestions from code review
maxulysse Jul 20, 2022
b1ce5bb
Updated test
WackerO Jul 20, 2022
b89d788
prettier
maxulysse Jul 20, 2022
cff880f
Merge pull request #669 from maxulysse/dev_restart_csv
maxulysse Jul 20, 2022
c8416b3
Merge branch 'dev' into dev_annotation_docs
maxulysse Jul 20, 2022
4b9bd9f
improve meta and tupleGrouping
Jul 20, 2022
2632a7b
add ifempty([]) in case ch_reports contains nothing
FriederikeHanssen Jul 20, 2022
467b2e6
Merge pull request #664 from maxulysse/dev_3.0_PR
maxulysse Jul 20, 2022
de5ad1a
Merge remote-tracking branch 'upstream/dev' into release_review
FriederikeHanssen Jul 20, 2022
eac90bd
Merge remote-tracking branch 'upstream/dev' into dev_annotation_docs
maxulysse Jul 20, 2022
44fb6d5
Merge branch 'dev_annotation_docs' of github.com:maxulysse/nf-core_sa…
maxulysse Jul 20, 2022
0e60f16
umis need to be passed properly
FriederikeHanssen Jul 20, 2022
3441df4
Merge pull request #667 from WackerO/svdb
maxulysse Jul 20, 2022
10cd8a2
merge upstream/dev
FriederikeHanssen Jul 20, 2022
a3c473c
update username [skip actions]
FriederikeHanssen Jul 20, 2022
9bae10f
Update conf/igenomes.config
nickhsmith Jul 20, 2022
b77a116
Update conf/modules.config
nickhsmith Jul 20, 2022
468dedb
Update nextflow_schema.json
nickhsmith Jul 20, 2022
e919d09
Update subworkflows/local/germline_variant_calling.nf
nickhsmith Jul 20, 2022
46bc423
Update subworkflows/local/germline_variant_calling.nf
nickhsmith Jul 20, 2022
f057709
Update germline_variant_calling.nf
nickhsmith Jul 20, 2022
4d50caf
Update subworkflows/nf-core/gatk4/joint_germline_variant_calling/main.nf
nickhsmith Jul 20, 2022
b734c5b
remove addressed todo strings
FriederikeHanssen Jul 20, 2022
c707f7c
meta format
Jul 20, 2022
ac0a1f5
undo publishDir change
Jul 20, 2022
caeb83a
add gavin to contirbutors list
FriederikeHanssen Jul 20, 2022
a6d6e9a
hardcode joint_variant_calling publish path
Jul 20, 2022
ce77595
Merge pull request #668 from maxulysse/dev_annotation_docs
FriederikeHanssen Jul 20, 2022
7f5a916
fix typo
Jul 20, 2022
c1c854b
Merge remote-tracking branch 'upstream/dev' into docs_igenomes
FriederikeHanssen Jul 20, 2022
30b4314
add joint germline docs
FriederikeHanssen Jul 20, 2022
6a893cc
merge upstream/dev
FriederikeHanssen Jul 20, 2022
c30f8fb
where do the ref genomes come from
FriederikeHanssen Jul 20, 2022
1fc9e2a
Merge remote-tracking branch 'NF-core/dev' into vqsr
Jul 20, 2022
702f3f5
remove duplicated sections
FriederikeHanssen Jul 20, 2022
8566b52
Merge branch 'dev' into update_igenomes
maxulysse Jul 20, 2022
c82a971
Update docs/usage.md
FriederikeHanssen Jul 20, 2022
6f41b7c
Merge pull request #660 from FriederikeHanssen/release_review
FriederikeHanssen Jul 20, 2022
395651d
Merge remote-tracking branch 'upstream/dev' into docs_igenomes
FriederikeHanssen Jul 20, 2022
0bc9403
remove duplicated sections
FriederikeHanssen Jul 20, 2022
d6bb67b
Merge pull request #673 from FriederikeHanssen/docs_igenomes
FriederikeHanssen Jul 20, 2022
d842fe0
Merge branch 'dev' into vqsr
nickhsmith Jul 20, 2022
80e08d8
tiny memory update + split fastq default value as discussed on slack
FriederikeHanssen Jul 20, 2022
06e3f46
change log
FriederikeHanssen Jul 20, 2022
8eaf5e7
forgot to cite eager for subway map
FriederikeHanssen Jul 20, 2022
6bd0051
we don't have 50000000 test reads, so 0 for testing
FriederikeHanssen Jul 20, 2022
73e84db
fix haplotypecaller cram input
nickhsmith Jul 20, 2022
b63e4ee
only remove sharded number for duplicate marking, and only at the ver…
FriederikeHanssen Jul 20, 2022
00aa3d5
Merge pull request #675 from FriederikeHanssen/cite
FriederikeHanssen Jul 21, 2022
9fa1a5c
fix indents, commas etc
FriederikeHanssen Jul 21, 2022
6c7f310
no default, and ploidy is a number
FriederikeHanssen Jul 21, 2022
b0c32c7
remove test file
nickhsmith Jul 21, 2022
51c6d6a
update version
maxulysse Jul 21, 2022
21b9f62
Merge pull request #595 from nickhsmith/vqsr
FriederikeHanssen Jul 21, 2022
25d91c2
Merge pull request #674 from FriederikeHanssen/small_ressource
FriederikeHanssen Jul 21, 2022
c54e097
merge upstream/dev
FriederikeHanssen Jul 21, 2022
19846b0
Merge remote-tracking branch 'upstream/dev' into update_igenomes
FriederikeHanssen Jul 21, 2022
1351292
merge upstream/dev
FriederikeHanssen Jul 21, 2022
c6cbec7
Merge pull request #676 from maxulysse/dev_3.0
apeltzer Jul 21, 2022
6431bab
update docs remove missing tbi
FriederikeHanssen Jul 21, 2022
f87517f
add tbi
FriederikeHanssen Jul 21, 2022
5cee6a4
update modules to match tools' versions
maxulysse Jul 21, 2022
2290c7f
Merge pull request #662 from FriederikeHanssen/update_igenomes
maxulysse Jul 21, 2022
d2556bb
Merge pull request #677 from maxulysse/dev_containers
maxulysse Jul 21, 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