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

Prepare release 1.0.0 #53

Merged
merged 275 commits into from
Jun 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
275 commits
Select commit Hold shift + click to select a range
d557945
Template update for nf-core/tools version 2.0.1
nf-core-bot Jul 13, 2021
d376a15
Template update for nf-core/tools version 2.1
nf-core-bot Jul 27, 2021
208ce8b
Merge branch 'dev' into dev_merge_template
maxulysse Jul 28, 2021
d5a70b6
fix: EClint
maxulysse Jul 28, 2021
13f971d
move files
maxulysse Jul 28, 2021
cfba18e
fix: nf-core lint
maxulysse Jul 28, 2021
e06b7aa
fix: update modules
maxulysse Jul 28, 2021
7bb0768
fix: EClint
maxulysse Jul 28, 2021
1871a5c
fix: remove module
maxulysse Jul 28, 2021
15d377f
fix: right paths to modules
maxulysse Jul 28, 2021
fb28875
fix: nf-core lint
maxulysse Jul 28, 2021
1bbfb81
fix: rename some files
maxulysse Jul 29, 2021
086ccdf
fix: move module to local
maxulysse Jul 29, 2021
1f0c390
fix: add PL to star align
maxulysse Aug 4, 2021
3b0e3ef
fix: EClint
maxulysse Aug 4, 2021
6f22458
fix: move modules to local
maxulysse Aug 4, 2021
69012c5
fix: CI should be ok now
maxulysse Aug 4, 2021
e006c7f
fix: remove unused file
maxulysse Aug 4, 2021
37b8350
fix: update json files
maxulysse Aug 4, 2021
d5542f1
fix: ECLint
maxulysse Aug 4, 2021
e60f602
Merge pull request #7 from maxulysse/dev_merge_template
maxulysse Aug 4, 2021
8e58ace
Merge pull request #6 from nf-core/nf-core-template-merge-2.1
maxulysse Aug 4, 2021
e56b465
itest
praveenraj2018 Oct 6, 2021
51cd1bb
changes
praveenraj2018 Nov 3, 2021
c3d4571
Fix: warnings, lint errors, code cleanup, docs
praveenraj2018 Nov 10, 2021
c625b25
cleaned
praveenraj2018 Nov 11, 2021
cfd9998
cleaned
praveenraj2018 Nov 11, 2021
e20873f
cleanup
praveenraj2018 Nov 11, 2021
a3476b9
synced all modules
praveenraj2018 Nov 11, 2021
b6958a8
fix: issues with splitNCigarReads
praveenraj2018 Nov 16, 2021
cad30e8
fix: replaced local gatk4 modules with nfcore repo
praveenraj2018 Nov 16, 2021
185d6d8
fixes; code cleanup; replaced local gatk4 modules with repo modules; …
praveenraj2018 Nov 18, 2021
5fbb84d
Fix: issue with cat_fastq; tested with multiple replicates
praveenraj2018 Nov 18, 2021
ebbc469
fix: lint warnings
praveenraj2018 Nov 18, 2021
4bc97fb
fix: lint editorconfig error
praveenraj2018 Nov 18, 2021
ffab2a1
update: samtools and picard modules updated to latest version from nf…
praveenraj2018 Nov 19, 2021
9ea279e
fix: lint warnings
praveenraj2018 Nov 19, 2021
17b7834
fix: usage.md
praveenraj2018 Nov 19, 2021
2fd9ef9
Update README.md
praveenraj2018 Nov 19, 2021
f9f5a6b
fix: igenomes; naming convention; initialize params
praveenraj2018 Nov 19, 2021
a1a3bff
Merge branch 'docs_toolsync_v2' of https://github.com/praveenraj2018/…
praveenraj2018 Nov 19, 2021
ef75020
Update bin/check_samplesheet.py
maxulysse Nov 22, 2021
6e024c3
Merge pull request #8 from praveenraj2018/docs_toolsync_v2
maxulysse Nov 22, 2021
abdd649
Added variant annotation subworkflow having snpeff and VEP
praveenraj2018 Nov 22, 2021
863a909
Added variant annotation subworkflow having snpeff and VEP
praveenraj2018 Nov 22, 2021
315420f
params.genome parameter added in test.config
praveenraj2018 Nov 22, 2021
77ac877
fix: capture ch_versions from annotate sub-workflow
praveenraj2018 Nov 22, 2021
5b6713f
update: snp and vep genome dataases in test.config
praveenraj2018 Nov 24, 2021
3f8e54d
fix: lint errors
praveenraj2018 Nov 24, 2021
cb92cc6
fix: lint errors on issue templates
praveenraj2018 Nov 24, 2021
a20f0ae
Added parameters for remove_duplicates and star_twopass
praveenraj2018 Nov 25, 2021
ede7f86
Merge pull request #9 from praveenraj2018/add_snpeff
praveenraj2018 Nov 25, 2021
868ed21
Update: parelle process for splitNcigar
praveenraj2018 Nov 30, 2021
79ffd18
fix: lint errors
praveenraj2018 Nov 30, 2021
dcd562e
fix: lint error in CI
praveenraj2018 Nov 30, 2021
e349fa6
fix: lint error in CI
praveenraj2018 Nov 30, 2021
ff4ffc5
update: splitNCigar runs in parallel
praveenraj2018 Nov 30, 2021
042251a
update: splitNCigar runs in parallel
praveenraj2018 Nov 30, 2021
63e29bf
update: splitNCigar runs in parallel
praveenraj2018 Nov 30, 2021
46ee545
Merge pull request #10 from praveenraj2018/parallel_proc
maxulysse Nov 30, 2021
b8cb3ee
fix: cache variable
praveenraj2018 Nov 30, 2021
2a0617e
fix: cache variable correction
praveenraj2018 Nov 30, 2021
1f20a5d
Merge pull request #11 from praveenraj2018/dev
maxulysse Dec 1, 2021
ca3c434
Fix: custom star index version check; --vcf syntax update for VEP
praveenraj2018 Dec 7, 2021
bbb86b6
Added GATK parameters
praveenraj2018 Dec 7, 2021
5a7d954
Fix: lint error
praveenraj2018 Dec 7, 2021
1bd2b26
for expert review
praveenraj2018 Dec 8, 2021
82b10da
check version of custom star_index
praveenraj2018 Dec 9, 2021
e94e65d
withdraw version check of custom star_index
praveenraj2018 Dec 9, 2021
ce1f437
Minor fixes
praveenraj2018 Dec 9, 2021
7691cef
Fix: Test errors
praveenraj2018 Dec 9, 2021
00ed2ad
Fix: Test errors - attempt 2
praveenraj2018 Dec 9, 2021
279f6e0
Fix: Test errors - attempt 3
praveenraj2018 Dec 9, 2021
070adb7
Fix: lint errors - attempt 4
praveenraj2018 Dec 9, 2021
17147b7
Fix: CI tests
praveenraj2018 Dec 10, 2021
46e605f
Fix: CI error in test_annotation.yml
praveenraj2018 Dec 10, 2021
8ef09d3
Fix: CI error in test_removeduplicates.yml
praveenraj2018 Dec 10, 2021
cc95d21
Correction in recalibrate subworkflow
praveenraj2018 Dec 10, 2021
b896576
Fix: CI tests
praveenraj2018 Dec 13, 2021
75279cc
Fix: CI tests - attempt 2
praveenraj2018 Dec 13, 2021
be8a80c
Fix: CI tests - attempt 3
praveenraj2018 Dec 13, 2021
e635be7
Fix: CI test errors
praveenraj2018 Dec 14, 2021
b898bca
Fix: CI test errors
praveenraj2018 Dec 14, 2021
f683003
Fix: Merge annotation test
praveenraj2018 Dec 14, 2021
6aa47d8
Merge pull request #13 from praveenraj2018/Docs_other_fixes
maxulysse Dec 14, 2021
698a7e2
Added rnavar custom config profile
praveenraj2018 Dec 14, 2021
24af2b8
fix: lint error
praveenraj2018 Dec 14, 2021
6420e7b
Update nextflow.config
maxulysse Dec 14, 2021
2159ce1
Merge pull request #14 from nf-core/praveenraj2018-patch-1
maxulysse Dec 14, 2021
eef058f
Template update for nf-core/tools version 2.2
nf-core-bot Dec 14, 2021
9b29fc1
All modules updated to DSL2 syntax
praveenraj2018 Jan 3, 2022
e6b9e18
Fix: lint error
praveenraj2018 Jan 3, 2022
25e49eb
Update for DSL2
praveenraj2018 Jan 4, 2022
c0f6c4d
DSL2 update
praveenraj2018 Jan 4, 2022
9288f41
Fix: lint errors
praveenraj2018 Jan 4, 2022
eb066f6
DSL2 transition; Fix: Issue with multiple samples
praveenraj2018 Jan 14, 2022
bff2abc
Add: multiplesamples CI test; code cleanup
praveenraj2018 Jan 14, 2022
b49a157
Merge pull request #16 from praveenraj2018/dsl2
maxulysse Jan 19, 2022
98896ef
Update docs
praveenraj2018 Jan 21, 2022
a91d188
Fix: samtools faidx issue with genome.fa
praveenraj2018 Jan 21, 2022
09b617f
pytest check
praveenraj2018 Jan 21, 2022
34c70dd
update: modules.config
praveenraj2018 Jan 21, 2022
cad5522
Merge pull request #17 from praveenraj2018/faidx_fix
maxulysse Jan 26, 2022
df8897a
ifix
praveenraj2018 Jan 31, 2022
608ec16
addressed merge conflicts
praveenraj2018 Jan 31, 2022
e46cb94
snp/indel databases are required [issue 001]
m3hdad Feb 1, 2022
6aff6d8
update: usage and output docs
praveenraj2018 Feb 2, 2022
02dce5b
update: test.config
praveenraj2018 Feb 2, 2022
06d911d
removed: get_chrom_sizes.nf file
praveenraj2018 Feb 2, 2022
cfbdcb8
fix: markdownlint errors
praveenraj2018 Feb 2, 2022
069521b
fix: markdownlint errors - attempt 2
praveenraj2018 Feb 2, 2022
98bf7ae
fix: markdownlint errors - attempt 3
praveenraj2018 Feb 2, 2022
7b7be1f
update: output.md
praveenraj2018 Feb 2, 2022
7923f32
corrections based on review
praveenraj2018 Feb 2, 2022
ec83b2c
corrections based on review - 2
praveenraj2018 Feb 2, 2022
3470214
added: skip_baserecalibration for non-model organisms
praveenraj2018 Feb 3, 2022
6eab34d
added: doc on skip_baserecalibration
praveenraj2018 Feb 3, 2022
fa94c88
fix: markdownlint
praveenraj2018 Feb 3, 2022
89892fe
fix: markdownlint - attempt 2
praveenraj2018 Feb 3, 2022
df16faa
fix: markdownlint - revert
praveenraj2018 Feb 3, 2022
e1f7e02
fix: nodeversion in linting.yml
praveenraj2018 Feb 3, 2022
cba3510
Merge pull request #22 from praveenraj2018/docs
praveenraj2018 Feb 3, 2022
d74962e
Merge pull request #18 from m3hdad/iss001
praveenraj2018 Feb 4, 2022
c41d905
gffread ext.args defined
m3hdad Feb 9, 2022
95d3db0
updating mandatory params to accept gff
m3hdad Feb 9, 2022
c2c0e61
Merge pull request #23 from praveenraj2018/skip_baserecalib
praveenraj2018 Feb 9, 2022
3e061d3
Merge pull request #24 from m3hdad/gffgtfFix
maxulysse Feb 9, 2022
06e1c81
Template update for nf-core/tools version 2.3
nf-core-bot Mar 15, 2022
fd6d41d
changes related to template merge
praveenraj2018 Mar 22, 2022
31d0152
changes related to template merge 2
praveenraj2018 Mar 22, 2022
b6035b4
changes related to template merge #3
praveenraj2018 Mar 22, 2022
d973e9b
fix: lint errors
praveenraj2018 Mar 22, 2022
4421577
fix: lint errors using --fix files_unchanged
praveenraj2018 Mar 22, 2022
c2085b5
Testing
praveenraj2018 Mar 22, 2022
6fc8aa7
Changed: fastq file name in samplesheet_test.csv
praveenraj2018 Mar 22, 2022
54c2b79
Fix: error while getting sample name from meta
praveenraj2018 Mar 22, 2022
0be70b4
Merge branch 'nf-core-template-merge-2.3.2' into dev
praveenraj2018 Mar 22, 2022
c5fb926
fix: prettier warnings
praveenraj2018 Mar 22, 2022
3aed3e7
fix: template merge; module updates
praveenraj2018 Mar 22, 2022
4cd923e
fix: prettier warning
praveenraj2018 Mar 22, 2022
41fcc58
update: local modules to DSL2 syntax; used nf-core gatk4/haplotypecaller
praveenraj2018 Mar 22, 2022
90e6290
fix: prettier warning
praveenraj2018 Mar 22, 2022
799b058
Merge branch 'dev' into dsl2_updates
praveenraj2018 Mar 22, 2022
e4bb266
Template update for nf-core/tools version 2.3.1
nf-core-bot Mar 23, 2022
305282a
Template update for nf-core/tools version 2.3.2
nf-core-bot Mar 24, 2022
57c5425
Update README.md
maxulysse Mar 30, 2022
73722a9
Merge pull request #32 from praveenraj2018/dev
praveenraj2018 Mar 30, 2022
8e01cd9
Merge pull request #33 from praveenraj2018/dsl2_updates
maxulysse Mar 30, 2022
8c4eeae
Removed unwanted folder
praveenraj2018 Mar 31, 2022
15dadc9
Removed older multiqc_config.yaml
praveenraj2018 Mar 31, 2022
1f91668
Commented out STAR version check as the logic is not working
praveenraj2018 Mar 31, 2022
4e02c25
Updated README.md with tool versions
praveenraj2018 Mar 31, 2022
fba2597
Updated gatk4/createsequencedictionary to the latest version
praveenraj2018 Mar 31, 2022
468ab35
Fix: prettier warning on modules.json
praveenraj2018 Mar 31, 2022
19d7f24
Update: review feedback - Tool versions as a table
praveenraj2018 Mar 31, 2022
dd3fef9
Update: review feedback - Tool versions as a table
praveenraj2018 Mar 31, 2022
13c402e
Fix: Prettier warning on README.md
praveenraj2018 Mar 31, 2022
b072f2e
Merge pull request #35 from praveenraj2018/doc_final_updates
praveenraj2018 Mar 31, 2022
6fe8e20
fix: renamed meta with interval BaseName to work correctly in MergeVCFs
praveenraj2018 Apr 4, 2022
0e84136
Merge pull request #36 from praveenraj2018/fix_hc_parallel
maxulysse Apr 4, 2022
96ef0ed
Add: Else clause to call genome index if star_index is not provided
praveenraj2018 Apr 8, 2022
495b171
Applied tools/pull/1510 to resolve email template error
praveenraj2018 Apr 8, 2022
273da53
Merge pull request #37 from praveenraj2018/issue_fix_runstopped
maxulysse Apr 8, 2022
c991821
Fix: error when the input genome.fasta is a compressed .gz file
praveenraj2018 Apr 8, 2022
0522137
Add: collect() to gtf
praveenraj2018 Apr 8, 2022
8beea48
Add: Limit parameters for STAR to manage memory failures; BAM in Coor…
praveenraj2018 Apr 8, 2022
7862e55
Merge pull request #38 from praveenraj2018/fix_other_issues
maxulysse Apr 9, 2022
75de194
Use vep_genome and snpeff_db when --genome is not specified
praveenraj2018 Apr 21, 2022
eb7f004
Fix: samplesheet_test.csv link
praveenraj2018 Apr 21, 2022
8f58654
Update: nf-core modules - #1
praveenraj2018 Apr 21, 2022
61274f3
Update: nf-core modules - #2
praveenraj2018 Apr 21, 2022
89a83f6
Update: nf-core modules - #3
praveenraj2018 Apr 21, 2022
32f175f
Changed logic for creating GTF2BED at exon level
praveenraj2018 Apr 21, 2022
27902f7
removed the un-used gtf_gene_filter.nf
praveenraj2018 Apr 21, 2022
530e8b8
Fix: avoid calling container when a local cache is provided for vep o…
praveenraj2018 Apr 22, 2022
3a007b0
Prettier fix; changes in Usage.md; Add: parameter validation in Workf…
praveenraj2018 Apr 22, 2022
250bc9f
Add: missing paramters in config; parameter validation in WorkflowRna…
praveenraj2018 Apr 22, 2022
8e8f79a
Merge pull request #40 from praveenraj2018/exonic_bed_other_fixes
maxulysse Apr 25, 2022
d1d5fc5
Fix: use of csi index when work with large genomes and --bam_csi_index
praveenraj2018 Apr 28, 2022
756afe1
update: doc for large genome and use of --bam_csi_index
praveenraj2018 Apr 28, 2022
9304107
Used nf-core version of gatk4/splitncigarreads
praveenraj2018 Apr 28, 2022
148466a
Fix: issues with known variants VCF resources
praveenraj2018 Apr 28, 2022
d0f6f00
Fix: known indels
praveenraj2018 Apr 28, 2022
e9c1e66
Fix: usage of known resources correctly.
praveenraj2018 Apr 29, 2022
d2a9da7
Fix: Editorconf and prettier issues
praveenraj2018 May 2, 2022
d10e930
Fix: Editorconf issue on modules.config
praveenraj2018 May 2, 2022
fb8f455
Used GATK4/markduplicates command instead of Picard/Markduplicate. Ju…
praveenraj2018 May 2, 2022
bc55a49
Prettier fix
praveenraj2018 May 2, 2022
5ef0c51
Update lib/WorkflowRnavar.groovy
praveenraj2018 May 2, 2022
03d48ae
Merge pull request #43 from praveenraj2018/csi_other_fixes
maxulysse May 2, 2022
a06f390
Simplified splitNCigar subworkflow; Fix: bam_csi_index; added test fo…
praveenraj2018 May 3, 2022
00cec58
Merge pull request #44 from praveenraj2018/quick_fix_csi
maxulysse May 3, 2022
31423b3
Changes related to test data file naming and its location
praveenraj2018 May 4, 2022
93dd0a7
Update: CITATIONS.md
praveenraj2018 May 4, 2022
e39eb6f
Update: README.md
praveenraj2018 May 4, 2022
e144189
Update: assets/schema_input.json
praveenraj2018 May 4, 2022
3541008
Update: conf/modules.config
praveenraj2018 May 4, 2022
e6ea933
Update: removed Path for FASTQC in conf/modules.config
praveenraj2018 May 4, 2022
882e465
Updated: README.md
praveenraj2018 May 4, 2022
9f5a98b
Update: usage.md
praveenraj2018 May 4, 2022
fc7a58e
Update: review feedback corrections
praveenraj2018 May 4, 2022
317498b
Correction: ext.args of HC
praveenraj2018 May 4, 2022
73facdc
update: assets/schema_input.json
praveenraj2018 May 4, 2022
45c0b81
Merge pull request #45 from praveenraj2018/review_corrections
maxulysse May 4, 2022
aa72ab3
Edited: test_full.config
praveenraj2018 May 5, 2022
5abe7d2
Added: default genome as GRCh38
praveenraj2018 May 5, 2022
471abee
Updated the samplesheet link
praveenraj2018 May 5, 2022
6292a05
Merge pull request #46 from praveenraj2018/review_fix2
praveenraj2018 May 5, 2022
85fc237
Changed munin profile to test in OUTPUT.md
praveenraj2018 May 9, 2022
591657f
Updated OUTPUT.md
praveenraj2018 May 9, 2022
30895db
Deleted .prettierignore
praveenraj2018 May 9, 2022
c5501ac
Added: citation for Tabix
praveenraj2018 May 9, 2022
b6ac130
Updated samtools version in README.md
praveenraj2018 May 9, 2022
4676cec
Update link in check_samplesheet.py
praveenraj2018 May 9, 2022
5460151
Removed commented line in conf/test.config
praveenraj2018 May 9, 2022
e78e5b5
Review corrections
praveenraj2018 May 9, 2022
73f7dfb
Fix syntax error
praveenraj2018 May 9, 2022
1f8354a
Changed: command used for this experiment
praveenraj2018 May 11, 2022
29d400b
Edited output.md
praveenraj2018 May 11, 2022
906ba55
Fix: python version in samplesheet_check.nf
praveenraj2018 May 11, 2022
8564ef8
Add: multiQC integration; Update doc with more content and plots; --s…
praveenraj2018 May 12, 2022
b718350
Fix: prettier issues
praveenraj2018 May 12, 2022
3924aac
Merge pull request #47 from praveenraj2018/review_round2
praveenraj2018 May 13, 2022
f960335
Template update for nf-core/tools version 2.4
nf-core-bot May 16, 2022
258baaf
Merge branch 'dev' into nf-core-template-merge-2.4
praveenraj2018 May 17, 2022
0a4f721
Merge pull request #48 from nf-core/nf-core-template-merge-2.4
praveenraj2018 May 17, 2022
88079ed
removed files_unchanged
praveenraj2018 May 17, 2022
7f15f58
fix: assets/email_template.html
praveenraj2018 May 17, 2022
b9dc6e7
Corrected nextflow version in manifest - nextflow.config
praveenraj2018 May 17, 2022
ba28939
Update: nf-core tools
praveenraj2018 May 17, 2022
13cb574
Merge pull request #49 from praveenraj2018/bump_tools_version
praveenraj2018 May 17, 2022
81976d0
Edits in documentations
praveenraj2018 May 23, 2022
9d77742
Merge pull request #51 from praveenraj2018/minor_corrections
praveenraj2018 May 23, 2022
3b53fe8
Bump version to 1.0.0; Edit CHANGELOG.md
praveenraj2018 May 24, 2022
1aff7bc
Edit: CHANGELOG.md
praveenraj2018 May 24, 2022
b565956
Edit: CHANGELOG.md
praveenraj2018 May 25, 2022
ed9e2a3
Merge pull request #52 from praveenraj2018/dev
praveenraj2018 Jun 2, 2022
249728c
Fix: Incorrect merging of samples - Issue #54
praveenraj2018 Jun 14, 2022
5a457b4
Added: citation for Tabix in CITATIONS.md
praveenraj2018 Jun 14, 2022
b53e07f
Update: mode of GUNZIP_* in modules.config
praveenraj2018 Jun 14, 2022
4881cda
Used multiline format for all process calls
praveenraj2018 Jun 14, 2022
bb05deb
Multiline formatting, ch_ prefix to all channels
praveenraj2018 Jun 14, 2022
253cbf8
Clean up of blank lines
praveenraj2018 Jun 14, 2022
4a9ad7b
Updated all test CI ymls to validate based on the testdata from repo
praveenraj2018 Jun 14, 2022
203545e
Relabelled STAR params to be more clean and clear
praveenraj2018 Jun 14, 2022
21ebd32
Edit: multiqc_config.yml to have the tools and their order in the rep…
praveenraj2018 Jun 15, 2022
1b72d4e
Added comments
praveenraj2018 Jun 15, 2022
7381dd3
Fix: prettier
praveenraj2018 Jun 15, 2022
1ea2855
Update: comments
praveenraj2018 Jun 15, 2022
e612b8f
Merge pull request #56 from praveenraj2018/dev
maxulysse Jun 16, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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/rnavar, the standard workflow is as follows:

1. Check that there isn't already an issue about your idea in the [nf-core/rnavar issues](https://github.com/nf-core/rnavar/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/rnavar issues](https://github.com/nf-core/rnavar/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/rnavar repository](https://github.com/nf-core/rnavar) 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).
64 changes: 0 additions & 64 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/rnavar pipeline documentation](https://nf-co.re/rnavar/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/rnavar _(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
32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Feature request
description: Suggest an idea for the nf-core/rnavar pipeline
labels: enhancement
body:
- type: textarea
id: description
attributes:
label: Description of feature
description: Please describe your suggestion for a new feature. It might help to describe a problem or use case, plus any alternatives that you have considered.
validations:
required: true
10 changes: 4 additions & 6 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,15 @@ Remember that PRs should be made against the dev branch, unless you're preparing

Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/rnavar/tree/master/.github/CONTRIBUTING.md)
-->
<!-- markdownlint-disable ul-indent -->

## PR checklist

- [ ] This comment contains a description of changes (with reason).
- [ ] If you've fixed a bug or added code that should be tested, add tests!
- [ ] If you've added a new tool - add to the software_versions process and a regex to `scrape_software_versions.py`
- [ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](<https://github.com/>nf-core/rnavar/tree/master/.github/CONTRIBUTING.md)
- [ ] If necessary, also make a PR on the nf-core/rnavar _branch_ on the [nf-core/test-datasets](https://github.com/nf-core/test-datasets) repository.
- [ ] Make sure your code lints (`nf-core lint .`).
- [ ] Ensure the test suite passes (`nextflow run . -profile test,docker`).
- [ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](https://github.com/nf-core/rnavar/tree/master/.github/CONTRIBUTING.md)
- [ ] If necessary, also make a PR on the nf-core/rnavar _branch_ on the [nf-core/test-datasets](https://github.com/nf-core/test-datasets) repository.
- [ ] Make sure your code lints (`nf-core lint`).
- [ ] Ensure the test suite passes (`nextflow run . -profile test,docker --outdir <OUTDIR>`).
- [ ] Usage Documentation in `docs/usage.md` is updated.
- [ ] Output Documentation in `docs/output.md` is updated.
- [ ] `CHANGELOG.md` is updated.
Expand Down
12 changes: 0 additions & 12 deletions .github/markdownlint.yml

This file was deleted.

49 changes: 16 additions & 33 deletions .github/workflows/awsfulltest.yml
Original file line number Diff line number Diff line change
@@ -1,46 +1,29 @@
name: nf-core AWS full size tests
# This workflow is triggered on published releases.
# It can be additionally triggered manually with GitHub actions workflow dispatch.
# It can be additionally triggered manually with GitHub actions workflow dispatch button.
# It runs the -profile 'test_full' on AWS batch

on:
workflow_run:
workflows: ["nf-core Docker push (release)"]
types: [completed]
release:
types: [published]
workflow_dispatch:


env:
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
TOWER_ACCESS_TOKEN: ${{ secrets.AWS_TOWER_TOKEN }}
AWS_JOB_DEFINITION: ${{ secrets.AWS_JOB_DEFINITION }}
AWS_JOB_QUEUE: ${{ secrets.AWS_JOB_QUEUE }}
AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}


jobs:
run-awstest:
run-tower:
name: Run AWS full tests
if: github.repository == 'nf-core/rnavar'
runs-on: ubuntu-latest
steps:
- name: Setup Miniconda
uses: conda-incubator/setup-miniconda@v2
with:
auto-update-conda: true
python-version: 3.7
- name: Install awscli
run: conda install -c conda-forge awscli
- name: Start AWS batch job
# TODO nf-core: You can customise AWS full pipeline tests as required
- name: Launch workflow via tower
uses: nf-core/tower-action@v3
# Add full size test data (but still relatively small datasets for few samples)
# on the `test_full.config` test runs with only one set of parameters
# Then specify `-profile test_full` instead of `-profile test` on the AWS batch command
run: |
aws batch submit-job \
--region eu-west-1 \
--job-name nf-core-rnavar \
--job-queue $AWS_JOB_QUEUE \
--job-definition $AWS_JOB_DEFINITION \
--container-overrides '{"command": ["nf-core/rnavar", "-r '"${GITHUB_SHA}"' -profile test --outdir s3://'"${AWS_S3_BUCKET}"'/rnavar/results-'"${GITHUB_SHA}"' -w s3://'"${AWS_S3_BUCKET}"'/rnavar/work-'"${GITHUB_SHA}"' -with-tower"], "environment": [{"name": "TOWER_ACCESS_TOKEN", "value": "'"$TOWER_ACCESS_TOKEN"'"}]}'
with:
workspace_id: ${{ secrets.TOWER_WORKSPACE_ID }}
access_token: ${{ secrets.TOWER_ACCESS_TOKEN }}
compute_env: ${{ secrets.TOWER_COMPUTE_ENV }}
workdir: s3://${{ secrets.AWS_S3_BUCKET }}/work/rnavar/work-${{ github.sha }}
parameters: |
{
"outdir": "s3://${{ secrets.AWS_S3_BUCKET }}/rnavar/results-${{ github.sha }}"
}
profiles: test_full,aws_tower
Loading