forked from bigbio/pgdb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathnextflow_schema.json
479 lines (478 loc) · 23.4 KB
/
nextflow_schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://raw.githubusercontent.com/nf-core/pgdb/master/nextflow_schema.json",
"title": "nf-core/pgdb pipeline parameters",
"description": "Proteogenomics database creation workflow using pypgatk framework. ",
"type": "object",
"definitions": {
"ensembl_canonical_proteomes": {
"title": "ENSEMBL canonical proteomes",
"type": "object",
"description": "Add ENSEMBL canonical proteomes",
"default": "",
"properties": {
"add_reference": {
"type": "boolean",
"default": true,
"description": "Add the reference proteome to the file"
},
"ensembl_downloader_config": {
"type": "string",
"description": "Path to configuration file for ENSEMBL download parameters"
},
"ensembl_config": {
"type": "string",
"description": "Path to configuration file for parameters in generating protein databases from ENSMEBL sequences"
},
"gencode_url": {
"type": "string",
"default": "ftp://ftp.ebi.ac.uk/pub/databases/gencode/Gencode_human/release_19",
"description": "URL for downloading GENCODE datafiles"
},
"ensembl_name": {
"type": "string",
"default": "homo_sapiens",
"description": "Taxonomic term for the species to download from ENSEMBL"
}
}
},
"non_canonical_proteome_parameters": {
"title": "Non canonical proteome parameters",
"type": "object",
"description": "Non canonical proteins generation parameters",
"default": "",
"properties": {
"ncrna": {
"type": "boolean",
"description": "Generate protein database from non-coding RNA"
},
"pseudogenes": {
"type": "boolean",
"description": "Generate protein database from pseudogenes"
},
"altorfs": {
"type": "boolean",
"description": "Generate alternative ORFs from canonical proteins"
},
"ensembl": {
"type": "boolean",
"description": "Download ENSEMBL variants and generate protein database"
}
}
},
"custom_vcf_based_variant_proteomes": {
"title": "Custom VCF-based variant proteomes",
"type": "object",
"description": "Proteins generated using an input VCF",
"default": "",
"properties": {
"vcf": {
"type": "boolean",
"description": "Enable translation of a given VCF file"
},
"vcf_file": {
"type": "string",
"description": "VCF file path to be translated. Generate variants proteins by modifying sequences of affected transcripts."
},
"af_field": {
"type": "string",
"description": "Allele frequency identifier string in VCF Info column, if no AF info is given set it to empty."
}
}
},
"cbioportal_variant_proteomes": {
"title": "cBioportal variant proteomes",
"type": "object",
"description": "cBioportal variant parameters",
"default": "",
"properties": {
"cbioportal": {
"type": "boolean",
"description": "Download cBioPortal studies and generate protein database"
},
"cbioportal_accepted_values": {
"type": "string",
"default": "all",
"description": "Specify a tissue type to limit the cBioPortal mutations to a particular caner type"
},
"cbioportal_filter_column": {
"type": "string",
"default": "CANCER_TYPE",
"description": "Specify a column from the clinical sample file to be used for filtering records"
},
"cbioportal_study_id": {
"type": "string",
"description": "Download mutations from a specific study in cbiportal default is all which downloads mutations from all studies"
},
"cbioportal_config": {
"type": "string",
"description": "cBioPortal configuration file"
}
}
},
"cosmic_variant_proteomes": {
"title": "COSMIC variant proteomes",
"type": "object",
"description": "COSMIC variant proteins parameters",
"default": "",
"properties": {
"cosmic": {
"type": "boolean",
"description": "Download COSMIC mutation files and generate protein database"
},
"cosmic_celllines": {
"type": "string",
"description": "Download COSMIC cell line files and generate protein database"
},
"cosmic_user_name": {
"type": "string",
"description": "User name (or email) for COSMIC account"
},
"cosmic_password": {
"type": "string",
"description": "Password for COSMIC account"
},
"cosmic_config": {
"type": "string",
"description": "Path to configuration file for parameters in generating"
},
"cosmic_cancer_type": {
"type": "string",
"default": "all",
"description": "Specify a tissue type to limit the COSMIC mutations to a particular caner type"
},
"cosmic_cellline_name": {
"type": "string",
"default": "all",
"description": "Specify a sample name to limit the COSMIC cell line mutations to a particular cell line"
},
"cosmicgenes": {
"type": "string",
"description": "Loading local cosmic protein database"
},
"cosmicmutations": {
"type": "string",
"description": "Loading local COSMIC mutation files"
},
"cosmiccelllines_genes": {
"type": "string",
"description": "Loading local cosmic_celllines protein database"
},
"cosmiccelllines_mutations": {
"type": "string",
"description": "Loading local COSMIC cell line files"
}
}
},
"gnomad_variant_proteomes": {
"title": "GNOMAD variant proteomes",
"type": "object",
"description": "",
"default": "",
"properties": {
"gnomad": {
"type": "boolean",
"description": "Add gNOMAD variants to the database"
},
"gnomad_file_url": {
"type": "string",
"default": "gs://gnomad-public/release/2.1.1/vcf/exomes/gnomad.exomes.r2.1.1.sites.vcf.bgz",
"description": "gNOMAD url"
}
}
},
"decoy_generation": {
"title": "Decoy generation",
"type": "object",
"description": "Generate decoy proteins and attach them to the final protein database",
"default": "",
"properties": {
"decoy": {
"type": "boolean",
"description": "Append the decoy proteins to the database"
},
"decoy_prefix": {
"type": "string",
"default": "Decoy_",
"description": "String to be used as prefix for the generated decoy sequences"
},
"decoy_method": {
"type": "string",
"default": "decoypyrat",
"description": "Method used to generate the decoy database",
"enum": [
"protein-reverse",
"protein-shuffle",
"decoypyrat"
]
},
"decoy_enzyme": {
"type": "string",
"default": "Trypsin",
"description": "Enzyme used to generate the decoy"
},
"protein_decoy_config": {
"type": "string",
"description": "Configuration file to perform the decoy generation"
}
}
},
"clean_and_process_database": {
"title": "Clean and process database",
"type": "object",
"description": "Clean and process the resulted database",
"default": "",
"properties": {
"clean_database": {
"type": "boolean",
"description": "Clean the database for stop codons, short protein sequences"
},
"minimum_aa": {
"type": "integer",
"default": 6,
"description": "Minimum number of AminoAcids for a protein to be included in the database"
},
"add_stop_codons": {
"type": "boolean",
"description": "If an stop codons is found, create two proteins from it"
}
}
},
"input_output_options": {
"title": "Input/output options",
"type": "object",
"fa_icon": "fas fa-terminal",
"description": "Define where the pipeline should find input data and save output data.",
"properties": {
"outdir": {
"type": "string",
"description": "The output directory where the results will be saved.",
"default": "./results",
"fa_icon": "fas fa-folder-open"
},
"email": {
"type": "string",
"description": "Email address for completion summary.",
"fa_icon": "fas fa-envelope",
"help_text": "Set this parameter to your e-mail address to get a summary e-mail with details of the run sent to you when the workflow exits. If set in your user config file (`~/.nextflow/config`) then you don't need to specify this on the command line for every run.",
"pattern": "^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$"
},
"final_database_protein": {
"type": "string",
"default": "final_proteinDB.fa",
"description": "Filename for the final protein database"
}
}
},
"generic_options": {
"title": "Generic options",
"type": "object",
"fa_icon": "fas fa-file-import",
"description": "Less common options for the pipeline, typically set in a config file.",
"help_text": "These options are common to all nf-core pipelines and allow you to customise some of the core preferences for how the pipeline runs.\n\nTypically these options would be set in a Nextflow config file loaded for all pipeline runs, such as `~/.nextflow/config`.",
"properties": {
"help": {
"type": "boolean",
"description": "Display help text.",
"hidden": true,
"fa_icon": "fas fa-question-circle"
},
"publish_dir_mode": {
"type": "string",
"default": "copy",
"hidden": true,
"description": "Method used to save pipeline results to output directory.",
"help_text": "The Nextflow `publishDir` option specifies which intermediate files should be saved to the output directory. This option tells the pipeline what method should be used to move these files. See [Nextflow docs](https://www.nextflow.io/docs/latest/process.html#publishdir) for details.",
"fa_icon": "fas fa-copy",
"enum": [
"symlink",
"rellink",
"link",
"copy",
"copyNoFollow",
"move"
]
},
"validate_params": {
"type": "boolean",
"description": "Boolean whether to validate parameters against the schema at runtime",
"default": true,
"fa_icon": "fas fa-check-square",
"hidden": true
},
"email_on_fail": {
"type": "string",
"description": "Email address for completion summary, only when pipeline fails.",
"fa_icon": "fas fa-exclamation-triangle",
"pattern": "^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$",
"hidden": true,
"help_text": "This works exactly as with `--email`, except emails are only sent if the workflow is not successful."
},
"plaintext_email": {
"type": "boolean",
"description": "Send plain-text email instead of HTML.",
"fa_icon": "fas fa-remove-format",
"hidden": true,
"help_text": "Set to receive plain-text e-mails instead of HTML formatted."
},
"max_multiqc_email_size": {
"type": "string",
"description": "File size limit when attaching MultiQC reports to summary emails.",
"default": "25.MB",
"fa_icon": "fas fa-file-upload",
"hidden": true,
"help_text": "If file generated by pipeline exceeds the threshold, it will not be attached."
},
"monochrome_logs": {
"type": "boolean",
"description": "Do not use coloured log outputs.",
"fa_icon": "fas fa-palette",
"hidden": true,
"help_text": "Set to disable colourful command line output and live life in monochrome."
},
"tracedir": {
"type": "string",
"description": "Directory to keep pipeline Nextflow logs and reports.",
"default": "${params.outdir}/pipeline_info",
"fa_icon": "fas fa-cogs",
"hidden": true
},
"show_hidden_params": {
"type": "boolean",
"fa_icon": "far fa-eye-slash",
"description": "Show all params when using `--help`",
"hidden": true,
"help_text": "By default, parameters set as _hidden_ in the schema are not shown on the command line when a user runs with `--help`. Specifying this option will tell the pipeline to show all parameters."
}
}
},
"max_job_request_options": {
"title": "Max job request options",
"type": "object",
"fa_icon": "fab fa-acquisitions-incorporated",
"description": "Set the top limit for requested resources for any single job.",
"help_text": "If you are running on a smaller system, a pipeline step requesting more resources than are available may cause the Nextflow to stop the run with an error. These options allow you to cap the maximum resources requested by any single job so that the pipeline will run on your system.\n\nNote that you can not _increase_ the resources requested by any job using these options. For that you will need your own configuration file. See [the nf-core website](https://nf-co.re/usage/configuration) for details.",
"properties": {
"max_cpus": {
"type": "integer",
"description": "Maximum number of CPUs that can be requested for any single job.",
"default": 16,
"fa_icon": "fas fa-microchip",
"hidden": true,
"help_text": "Use to set an upper-limit for the CPU requirement for each process. Should be an integer e.g. `--max_cpus 1`"
},
"max_memory": {
"type": "string",
"description": "Maximum amount of memory that can be requested for any single job.",
"default": "128.GB",
"fa_icon": "fas fa-memory",
"pattern": "^[\\d\\.]+\\s*.(K|M|G|T)?B$",
"hidden": true,
"help_text": "Use to set an upper-limit for the memory requirement for each process. Should be a string in the format integer-unit e.g. `--max_memory '8.GB'`"
},
"max_time": {
"type": "string",
"description": "Maximum amount of time that can be requested for any single job.",
"default": "240.h",
"fa_icon": "far fa-clock",
"pattern": "^(\\d+(\\.\\d+)?(?:\\s*|\\.?)(s|m|h|d)\\s*)+$",
"hidden": true,
"help_text": "Use to set an upper-limit for the time requirement for each process. Should be a string in the format integer-unit e.g. `--max_time '2.h'`"
}
}
},
"institutional_config_options": {
"title": "Institutional config options",
"type": "object",
"fa_icon": "fas fa-university",
"description": "Parameters used to describe centralised config profiles. These should not be edited.",
"help_text": "The centralised nf-core configuration profiles use a handful of pipeline parameters to describe themselves. This information is then printed to the Nextflow log when you run a pipeline. You should not need to change these values when you run a pipeline.",
"properties": {
"custom_config_version": {
"type": "string",
"description": "Git commit id for Institutional configs.",
"default": "master",
"hidden": true,
"fa_icon": "fas fa-users-cog",
"help_text": "Provide git commit id for custom Institutional configs hosted at `nf-core/configs`. This was implemented for reproducibility purposes. Default: `master`.\n\n```bash\n## Download and use config file with following git commit id\n--custom_config_version d52db660777c4bf36546ddb188ec530c3ada1b96\n```"
},
"custom_config_base": {
"type": "string",
"description": "Base directory for Institutional configs.",
"default": "https://raw.githubusercontent.com/nf-core/configs/master",
"hidden": true,
"help_text": "If you're running offline, nextflow will not be able to fetch the institutional config files from the internet. If you don't need them, then this is not a problem. If you do need them, you should download the files from the repo and tell nextflow where to find them with the `custom_config_base` option. For example:\n\n```bash\n## Download and unzip the config files\ncd /path/to/my/configs\nwget https://github.com/nf-core/configs/archive/master.zip\nunzip master.zip\n\n## Run the pipeline\ncd /path/to/my/data\nnextflow run /path/to/pipeline/ --custom_config_base /path/to/my/configs/configs-master/\n```\n\n> Note that the nf-core/tools helper package has a `download` command to download all required pipeline files + singularity containers + institutional configs in one go for you, to make this process easier.",
"fa_icon": "fas fa-users-cog"
},
"hostnames": {
"type": "string",
"description": "Institutional configs hostname.",
"hidden": true,
"fa_icon": "fas fa-users-cog"
},
"config_profile_name": {
"type": "string",
"description": "Institutional config name.",
"hidden": true,
"fa_icon": "fas fa-users-cog"
},
"config_profile_description": {
"type": "string",
"description": "Institutional config description.",
"hidden": true,
"fa_icon": "fas fa-users-cog"
},
"config_profile_contact": {
"type": "string",
"description": "Institutional config contact information.",
"hidden": true,
"fa_icon": "fas fa-users-cog"
},
"config_profile_url": {
"type": "string",
"description": "Institutional config URL link.",
"hidden": true,
"fa_icon": "fas fa-users-cog"
}
}
}
},
"allOf": [
{
"$ref": "#/definitions/ensembl_canonical_proteomes"
},
{
"$ref": "#/definitions/non_canonical_proteome_parameters"
},
{
"$ref": "#/definitions/custom_vcf_based_variant_proteomes"
},
{
"$ref": "#/definitions/cbioportal_variant_proteomes"
},
{
"$ref": "#/definitions/cosmic_variant_proteomes"
},
{
"$ref": "#/definitions/gnomad_variant_proteomes"
},
{
"$ref": "#/definitions/decoy_generation"
},
{
"$ref": "#/definitions/clean_and_process_database"
},
{
"$ref": "#/definitions/input_output_options"
},
{
"$ref": "#/definitions/generic_options"
},
{
"$ref": "#/definitions/max_job_request_options"
},
{
"$ref": "#/definitions/institutional_config_options"
}
]
}