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

Pgdb dsl2 #14

Merged
merged 246 commits into from
Jun 22, 2022
Merged
Show file tree
Hide file tree
Changes from 117 commits
Commits
Show all changes
246 commits
Select commit Hold shift + click to select a range
8b78315
Template update for nf-core/tools version 1.13
nf-core-bot Mar 18, 2021
7809e6e
Template update for nf-core/tools version 1.13.1
nf-core-bot Mar 19, 2021
e67f2a4
Template update for nf-core/tools version 1.13.2
nf-core-bot Mar 23, 2021
ed6dc7c
Template update for nf-core/tools version 1.13.3
nf-core-bot Mar 25, 2021
93534ef
Template update for nf-core/tools version 1.14
nf-core-bot May 11, 2021
13bb201
Template update for nf-core/tools version 2.0
KevinMenden Jul 13, 2021
73f922f
Template update for nf-core/tools version 2.0.1
nf-core-bot Jul 13, 2021
a70b29f
Template update for nf-core/tools version 2.1
nf-core-bot Jul 27, 2021
0818558
Template update for nf-core/tools version 2.2
nf-core-bot Dec 14, 2021
558c74b
Template update for nf-core/tools version 2.3
nf-core-bot Mar 15, 2022
821a399
Template update for nf-core/tools version 2.3.1
nf-core-bot Mar 23, 2022
1fc21f3
Template update for nf-core/tools version 2.3.2
nf-core-bot Mar 24, 2022
38b0ead
enhancement
DongdongdongW May 14, 2022
f118e3c
Update test.config
DongdongdongW May 16, 2022
10e0fea
Update test.config
DongdongdongW May 16, 2022
a7f4851
Update test.config
DongdongdongW May 16, 2022
7711528
Template update for nf-core/tools version 2.4
nf-core-bot May 16, 2022
21075f0
Add files via upload
DongdongdongW May 19, 2022
00bbbf4
Add files via upload
DongdongdongW May 19, 2022
414d0d1
Add files via upload
DongdongdongW May 19, 2022
a576bbf
Add files via upload
DongdongdongW May 19, 2022
b675fb9
Add files via upload
DongdongdongW May 19, 2022
344f97c
Add files via upload
DongdongdongW May 19, 2022
577afc9
Delete bug_report.md
DongdongdongW May 19, 2022
d13f0d9
Delete feature_request.md
DongdongdongW May 19, 2022
9821e99
Add files via upload
DongdongdongW May 20, 2022
4436905
Delete .editorconfig
DongdongdongW May 21, 2022
005105a
Delete .prettierrc.yml
DongdongdongW May 21, 2022
fd21169
Add files via upload
DongdongdongW May 21, 2022
3540560
Add files via upload
DongdongdongW May 21, 2022
779f34f
Add files via upload
DongdongdongW May 21, 2022
e562480
Delete nf-core-pgdb_logo.png
DongdongdongW May 21, 2022
b1708f1
Delete nf-core-pgdb_logo.png
DongdongdongW May 21, 2022
941e075
Update README.md
DongdongdongW May 21, 2022
9f6a06f
Update .gitattributes
DongdongdongW May 21, 2022
8849f98
Update .gitattributes
DongdongdongW May 21, 2022
1355e10
Update LICENSE
DongdongdongW May 21, 2022
3f8e76a
Add files via upload
DongdongdongW May 21, 2022
36aaa5c
Update .dockstore.yml
DongdongdongW May 21, 2022
2b402e7
Update branch.yml
DongdongdongW May 21, 2022
15e70f8
Update linting_comment.yml
DongdongdongW May 21, 2022
dec6e5c
Update email_template.html
DongdongdongW May 21, 2022
df66176
Delete multiqc_config.yaml
DongdongdongW May 21, 2022
5455001
Add files via upload
DongdongdongW May 21, 2022
3e57d5e
Update README.md
DongdongdongW May 21, 2022
f22781b
Add files via upload
DongdongdongW May 21, 2022
89e38ad
Update .gitignore
DongdongdongW May 21, 2022
f202a32
Update awsfulltest.yml
DongdongdongW May 21, 2022
f311031
Update nextflow.config
DongdongdongW May 21, 2022
95e28bb
Update modules.json
DongdongdongW May 21, 2022
e9b00ae
Delete modules/nf-core/modules/custom/dumpsoftwareversions directory
DongdongdongW May 21, 2022
41de4be
Delete modules/nf-core/modules/fastqc directory
DongdongdongW May 21, 2022
55de1f8
Delete modules/nf-core/modules/multiqc directory
DongdongdongW May 21, 2022
6df04b8
Add files via upload
DongdongdongW May 21, 2022
79a86fd
Add files via upload
DongdongdongW May 22, 2022
d83c3fc
Add files via upload
DongdongdongW May 22, 2022
f85f736
Add files via upload
DongdongdongW May 22, 2022
aabda76
Add files via upload
DongdongdongW May 22, 2022
8acd557
Add files via upload
DongdongdongW May 22, 2022
87e29c8
Add files via upload
DongdongdongW May 22, 2022
98794a3
Add files via upload
DongdongdongW May 22, 2022
7d384ea
Add files via upload
DongdongdongW May 22, 2022
ff9f83f
Delete linting.yml
DongdongdongW May 22, 2022
fa235c6
Update nextflow.config
DongdongdongW May 22, 2022
0e6846b
Add files via upload
DongdongdongW May 25, 2022
6e8510a
Add files via upload
DongdongdongW May 25, 2022
1dd2cd3
Add files via upload
DongdongdongW May 25, 2022
5ef3e5a
Update README.md
DongdongdongW May 26, 2022
039a584
Update README.md
DongdongdongW May 26, 2022
260a2d8
Add files via upload
DongdongdongW May 26, 2022
0e0124d
Add files via upload
DongdongdongW May 26, 2022
123ffca
Update README.md
DongdongdongW May 26, 2022
7a6c03f
Update ci.yml
DongdongdongW May 27, 2022
0343a1d
Revert "Update ci.yml"
DongdongdongW May 27, 2022
179ab78
Update ci.yml
DongdongdongW May 27, 2022
6886b1e
Revert "Update ci.yml"
DongdongdongW May 27, 2022
320750a
Delete modules/local directory
DongdongdongW May 27, 2022
33bb29b
update folder name
DongdongdongW May 27, 2022
33824e2
Update pgdb.nf
DongdongdongW May 27, 2022
50a0ed6
Update ci.yml
DongdongdongW May 27, 2022
19351a7
Add files via upload
DongdongdongW May 28, 2022
580b850
Add files via upload
DongdongdongW May 28, 2022
05b6887
Add files via upload
DongdongdongW May 28, 2022
a6a65f6
update
DongdongdongW May 28, 2022
d2052c4
add testfull
DongdongdongW May 28, 2022
8a62296
add test_full
DongdongdongW May 28, 2022
79c2a35
update
DongdongdongW May 30, 2022
bb83137
update
DongdongdongW May 30, 2022
86e85da
add container
DongdongdongW Jun 1, 2022
b9fea6a
update module config
DongdongdongW Jun 1, 2022
07c852f
add cosmic test
DongdongdongW Jun 1, 2022
75c36c3
Update ci.yml
DongdongdongW Jun 1, 2022
6ae00e2
test cosmic
DongdongdongW Jun 1, 2022
2c4eb3e
add test
DongdongdongW Jun 1, 2022
d68d353
restore
DongdongdongW Jun 1, 2022
03b0d7c
Update ci.yml
ypriverol Jun 3, 2022
cd6555b
Update ci.yml
ypriverol Jun 3, 2022
7d30eca
Update ci.yml
ypriverol Jun 3, 2022
59b6d3e
Update ci.yml
ypriverol Jun 4, 2022
6f6de6f
Merge pull request #13 from DongdongdongW/pgdb-dsl2
ypriverol Jun 5, 2022
d37f58b
Update ci.yml
ypriverol Jun 5, 2022
de8ea59
merge template 2.4.0
ypriverol Jun 5, 2022
e463dde
merge template 2.4.0
ypriverol Jun 5, 2022
65f9fb5
merge template 2.4.0
ypriverol Jun 5, 2022
b668290
merge template 2.4.0
ypriverol Jun 5, 2022
ab4e698
merge template 2.4.0
ypriverol Jun 6, 2022
58be0c4
merge template 2.4.0
ypriverol Jun 6, 2022
b51f340
merge template 2.4.0
ypriverol Jun 6, 2022
af28aef
merge template 2.4.0
ypriverol Jun 6, 2022
a37b65b
merge template 2.4.0
ypriverol Jun 6, 2022
e962ec1
merge template 2.4.0
ypriverol Jun 6, 2022
aae91fa
merge template 2.4.0
ypriverol Jun 6, 2022
03229b3
merge template 2.4.0
ypriverol Jun 6, 2022
79828db
merge template 2.4.0
ypriverol Jun 6, 2022
2174fea
merge template 2.4.0
ypriverol Jun 6, 2022
8e02c1f
merge template 2.4.0
ypriverol Jun 6, 2022
3f2a411
merge template 2.4.0
ypriverol Jun 6, 2022
39090c1
merge template 2.4.0
ypriverol Jun 6, 2022
78be240
merge template 2.4.0
ypriverol Jun 6, 2022
b7ba76b
merge template 2.4.0
ypriverol Jun 6, 2022
f9a827d
merge template 2.4.0
ypriverol Jun 6, 2022
b1ae2a2
merge template 2.4.0
ypriverol Jun 6, 2022
17069e9
merge template 2.4.0
ypriverol Jun 6, 2022
d5b499d
merge template 2.4.0
ypriverol Jun 6, 2022
9a84b68
merge template 2.4.0
ypriverol Jun 6, 2022
6011982
update ensembl_config
DongdongdongW Jun 6, 2022
205e190
merge template 2.4.0
ypriverol Jun 6, 2022
02eba31
Merge remote-tracking branch 'bigbio/pgdb-dsl2' into pgdb-dsl2
ypriverol Jun 6, 2022
4c248aa
merge template 2.4.0
ypriverol Jun 6, 2022
b6e0ef4
merge template 2.4.0
ypriverol Jun 6, 2022
6675171
merge template 2.4.0
ypriverol Jun 6, 2022
1bf0025
merge template 2.4.0
ypriverol Jun 6, 2022
982e7fe
merge template 2.4.0
ypriverol Jun 6, 2022
1f8ee60
merge template 2.4.0
ypriverol Jun 6, 2022
01f2d59
merge template 2.4.0
ypriverol Jun 6, 2022
06c93c2
merge template 2.4.0
ypriverol Jun 6, 2022
01c4970
merge template 2.4.0
ypriverol Jun 7, 2022
8281c8b
add the Singularity and Conda containers
DongdongdongW Jun 7, 2022
11183c0
Revert "update ensembl_config"
DongdongdongW Jun 7, 2022
6ce5d64
Update ensembl_fasta_download.nf
DongdongdongW Jun 7, 2022
f16f5ae
update containers
DongdongdongW Jun 7, 2022
f22f89a
fix warning
DongdongdongW Jun 8, 2022
b203ba5
Update nextflow_schema.json
DongdongdongW Jun 8, 2022
e1452f9
Revert "Update nextflow_schema.json"
DongdongdongW Jun 8, 2022
50120f1
Revert "fix warning"
DongdongdongW Jun 8, 2022
f083ac3
Modify variables
DongdongdongW Jun 8, 2022
b221c53
modify variables
DongdongdongW Jun 8, 2022
aefd3ce
Update extract_gnomad_vcf.nf
DongdongdongW Jun 8, 2022
642de8e
update vcf variables
DongdongdongW Jun 8, 2022
9e3a01e
Revert "update vcf variables"
DongdongdongW Jun 9, 2022
10d8134
fix af_field
DongdongdongW Jun 9, 2022
1ded36a
update containers
DongdongdongW Jun 9, 2022
b43c765
error
DongdongdongW Jun 9, 2022
c0503e7
add variables
DongdongdongW Jun 9, 2022
036c3d1
test
DongdongdongW Jun 9, 2022
3c1607a
Revert "test"
DongdongdongW Jun 9, 2022
57769b1
test
DongdongdongW Jun 9, 2022
0b90d65
Revert "test"
DongdongdongW Jun 9, 2022
8446b0b
Update ensembl_fasta_download.nf
DongdongdongW Jun 9, 2022
0e530b1
Revert "Update ensembl_fasta_download.nf"
DongdongdongW Jun 9, 2022
6ac8d1e
Update ensembl_fasta_download.nf
DongdongdongW Jun 9, 2022
bab9bd3
Revert "Update ensembl_fasta_download.nf"
DongdongdongW Jun 9, 2022
4e3621f
Revert "add variables"
DongdongdongW Jun 9, 2022
d509a2f
update
DongdongdongW Jun 9, 2022
4ce4dad
Revert "update"
DongdongdongW Jun 9, 2022
f23d869
Update ensembl_fasta_download.nf
DongdongdongW Jun 9, 2022
639424f
Update pgdb.nf
DongdongdongW Jun 9, 2022
675543a
update
DongdongdongW Jun 9, 2022
3c9a1da
update variables
DongdongdongW Jun 9, 2022
3a377a9
Update decoy.nf
DongdongdongW Jun 9, 2022
19e7f11
update local cosmic data
DongdongdongW Jun 9, 2022
b2ec592
Update nextflow_schema.json
DongdongdongW Jun 9, 2022
ff22bef
Update nextflow_schema.json
DongdongdongW Jun 9, 2022
3f1e8d5
prettier
DongdongdongW Jun 9, 2022
05723c5
prettier
DongdongdongW Jun 9, 2022
56f5339
Revert "prettier"
DongdongdongW Jun 9, 2022
e5c3701
Revert "prettier"
DongdongdongW Jun 9, 2022
6cc4518
prettier
DongdongdongW Jun 9, 2022
dbb8193
prettier
DongdongdongW Jun 9, 2022
45fc726
Update nextflow_schema.json
DongdongdongW Jun 9, 2022
f2015f1
Revert "Update nextflow_schema.json"
DongdongdongW Jun 9, 2022
a8f499f
Revert "prettier"
DongdongdongW Jun 9, 2022
4556043
Revert "prettier"
DongdongdongW Jun 9, 2022
590f207
Update nextflow_schema.json
DongdongdongW Jun 9, 2022
91b9fca
Revert "Update nextflow_schema.json"
DongdongdongW Jun 9, 2022
2ab95e5
Revert "Update nextflow_schema.json"
DongdongdongW Jun 10, 2022
3b14346
Revert "Update nextflow_schema.json"
DongdongdongW Jun 10, 2022
dd5f63d
test
DongdongdongW Jun 10, 2022
a2ac77f
Update nextflow_schema.json
DongdongdongW Jun 10, 2022
6d43d0f
Update nextflow_schema.json
DongdongdongW Jun 10, 2022
586bd60
Update nextflow_schema.json
DongdongdongW Jun 10, 2022
745ee7f
Revert "Update nextflow_schema.json"
DongdongdongW Jun 10, 2022
e9ce9b2
Update nextflow_schema.json
DongdongdongW Jun 10, 2022
361e3b1
Update nextflow_schema.json
DongdongdongW Jun 10, 2022
a76a26f
Update nextflow_schema.json
DongdongdongW Jun 10, 2022
366f7ee
Update nextflow_schema.json
DongdongdongW Jun 10, 2022
5d1c4a3
add hostname and final_database_protein
DongdongdongW Jun 10, 2022
ee6cdc3
Revert "add hostname and final_database_protein"
DongdongdongW Jun 10, 2022
2f51f91
Revert "Update nextflow_schema.json"
DongdongdongW Jun 10, 2022
f51074f
Revert "Update nextflow_schema.json"
DongdongdongW Jun 10, 2022
be16d11
Update nextflow_schema.json
DongdongdongW Jun 10, 2022
4870513
Update nextflow_schema.json
DongdongdongW Jun 10, 2022
55fe93f
Revert "Update nextflow_schema.json"
DongdongdongW Jun 10, 2022
eaf3eef
Update nextflow_schema.json
DongdongdongW Jun 10, 2022
a0483b4
Update nextflow_schema.json
DongdongdongW Jun 10, 2022
e9a9a98
Revert "Update nextflow_schema.json"
DongdongdongW Jun 10, 2022
53f61d8
Update nextflow_schema.json
DongdongdongW Jun 10, 2022
2874559
Update nextflow_schema.json
DongdongdongW Jun 10, 2022
455cfa4
merge template 2.4.0
ypriverol Jun 11, 2022
af1461c
add enable_conda
DongdongdongW Jun 12, 2022
7b81a57
remove dump_version
DongdongdongW Jun 12, 2022
8e742a7
Revert "remove dump_version"
DongdongdongW Jun 12, 2022
44398c9
Update base.config
DongdongdongW Jun 12, 2022
cbdc7e3
add cosmic test
DongdongdongW Jun 12, 2022
9a80718
Update ci.yml
DongdongdongW Jun 12, 2022
4655329
merge template 2.4.0
ypriverol Jun 12, 2022
03b9c32
Update download_all_cbioportal.nf
DongdongdongW Jun 13, 2022
3716fa3
Merge branch 'pgdb-dsl2' of https://github.com/bigbio/pgdb into pgdb-…
DongdongdongW Jun 13, 2022
8c7303c
Revert "Merge branch 'pgdb-dsl2' of https://github.com/bigbio/pgdb in…
DongdongdongW Jun 13, 2022
55b55b6
Revert "Revert "Merge branch 'pgdb-dsl2' of https://github.com/bigbio…
DongdongdongW Jun 13, 2022
51a2efc
Update test_full.config
DongdongdongW Jun 13, 2022
4168b99
Update cosmic_download.nf
DongdongdongW Jun 13, 2022
8f5bb63
Revert "Update cosmic_download.nf"
DongdongdongW Jun 13, 2022
0e90728
Update cosmic_config.yaml
DongdongdongW Jun 13, 2022
34768c9
Revert "Update cosmic_config.yaml"
DongdongdongW Jun 13, 2022
e4530c2
update cosmic download
DongdongdongW Jun 16, 2022
689ea44
test homo ensembl
DongdongdongW Jun 18, 2022
d7024b0
Revert "test homo ensembl"
DongdongdongW Jun 18, 2022
0660371
Update test_full.config
DongdongdongW Jun 18, 2022
3833a1a
Revert "Update test_full.config"
DongdongdongW Jun 18, 2022
8f22463
add software version
DongdongdongW Jun 18, 2022
18eb32f
fix
DongdongdongW Jun 18, 2022
bd5058c
remove version
DongdongdongW Jun 18, 2022
74cd62e
test cbio
DongdongdongW Jun 19, 2022
587e6b5
add cbio containers
DongdongdongW Jun 19, 2022
d97f5b7
Update download_all_cbioportal.nf
DongdongdongW Jun 19, 2022
8295ddb
Update download_all_cbioportal.nf
DongdongdongW Jun 19, 2022
a3431e3
Update download_all_cbioportal.nf
DongdongdongW Jun 19, 2022
24c8507
Update download_all_cbioportal.nf
DongdongdongW Jun 19, 2022
ff3b83e
add cosmic cell lines test
DongdongdongW Jun 19, 2022
264033a
Update nextflow_schema.json
DongdongdongW Jun 19, 2022
6281be3
Update download_all_cbioportal.nf
DongdongdongW Jun 19, 2022
df9bc77
Update ci.yml
DongdongdongW Jun 19, 2022
8c102bc
add cbio test
DongdongdongW Jun 19, 2022
815c9c3
update cbio
DongdongdongW Jun 20, 2022
a815e8b
add test
DongdongdongW Jun 22, 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 = false
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
1 change: 1 addition & 0 deletions .github/.dockstore.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ version: 1.2
workflows:
- subclass: nfl
primaryDescriptorPath: /nextflow.config
publish: True
57 changes: 16 additions & 41 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/pgdb, the standard workflow is as follows:

1. Check that there isn't already an issue about your idea in the [nf-core/pgdb issues](https://github.com/nf-core/pgdb/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/pgdb issues](https://github.com/nf-core/pgdb/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/pgdb repository](https://github.com/nf-core/pgdb) 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,61 +67,37 @@ 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

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/%7B%7Bcookiecutter.name_noslash%7D%7D/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/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.

The process resources can be passed on to the tool dynamically within the process with the `${task.cpu}` and `${task.memory}` variables in the `script:` block.

### Naming schemes

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/pgdb pipeline documentation](https://nf-co.re/pgdb/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/pgdb _(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/pgdb 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
9 changes: 4 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,10 @@ Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/pgdb

- [ ] 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/pgdb/tree/master/.github/CONTRIBUTING.md)
- [ ] If necessary, also make a PR on the nf-core/pgdb _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/pgdb/tree/master/.github/CONTRIBUTING.md)
- [ ] If necessary, also make a PR on the nf-core/pgdb _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.

46 changes: 15 additions & 31 deletions .github/workflows/awsfulltest.yml
Original file line number Diff line number Diff line change
@@ -1,43 +1,27 @@
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:

jobs:
run-awstest:
run-tower:
name: Run AWS full tests
if: github.repository == 'nf-core/pgdb'
runs-on: ubuntu-latest
steps:
- name: Setup Miniconda
uses: conda-incubator/setup-miniconda@v2
- name: Launch workflow via tower
uses: nf-core/tower-action@v3
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
# 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
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 }}
run: |
aws batch submit-job \
--region eu-west-1 \
--job-name nf-core-pgdb \
--job-queue $AWS_JOB_QUEUE \
--job-definition $AWS_JOB_DEFINITION \
--container-overrides '{"command": ["nf-core/pgdb", "-r '"${GITHUB_SHA}"' -profile test --outdir s3://'"${AWS_S3_BUCKET}"'/pgdb/results-'"${GITHUB_SHA}"' -w s3://'"${AWS_S3_BUCKET}"'/pgdb/work-'"${GITHUB_SHA}"' -with-tower"], "environment": [{"name": "TOWER_ACCESS_TOKEN", "value": "'"$TOWER_ACCESS_TOKEN"'"}]}'
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/pgdb/work-${{ github.sha }}
parameters: |
{
"outdir": "s3://${{ secrets.AWS_S3_BUCKET }}/pgdb/results-${{ github.sha }}"
}
profiles: test_full,aws_tower
Loading