-
Notifications
You must be signed in to change notification settings - Fork 20
/
Copy pathnextflow_schema.json
368 lines (363 loc) · 18.7 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
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/nf-core/spatialvi/master/nextflow_schema.json",
"title": "nf-core/spatialvi pipeline parameters",
"description": "10X Visium Spatial Transcriptomics",
"type": "object",
"$defs": {
"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.",
"required": ["input", "outdir"],
"properties": {
"input": {
"type": "string",
"format": "file-path",
"exists": true,
"schema": "assets/schema_input.json",
"mimetype": "text/csv",
"pattern": "^\\S+\\.csv$",
"description": "Path to comma-separated file containing information about the samples in the experiment.",
"help_text": "You will need to create a design file with information about the samples in your experiment before running the pipeline, use this parameter to specify its location. It has to be a comma-separated file with 2 or 5 columns, plus a header row. See [usage docs](https://nf-co.re/spatialvi/usage#samplesheet-input).",
"fa_icon": "fas fa-file-csv"
},
"outdir": {
"type": "string",
"format": "directory-path",
"description": "The output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure.",
"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})$"
},
"multiqc_title": {
"type": "string",
"description": "MultiQC report title. Printed as page header, used for filename if not otherwise specified.",
"fa_icon": "fas fa-file-signature"
}
}
},
"spaceranger_options": {
"title": "Space Ranger options",
"type": "object",
"fa_icon": "fas fa-rocket",
"description": "Options related to Space Ranger execution and raw spatial data processing",
"properties": {
"spaceranger_probeset": {
"type": "string",
"format": "file-path",
"mimetype": "text/csv",
"pattern": "^\\S+\\.csv$",
"description": "Location of Space Ranger probeset file.",
"fa_icon": "fas fa-file-csv",
"exists": true
},
"spaceranger_reference": {
"type": "string",
"format": "path",
"description": "Location of Space Ranger reference directory. May be packed as `tar.gz` file.",
"help_text": "Please see the [10x website](https://support.10xgenomics.com/spatial-gene-expression/software/downloads/latest) to download either of the supported human or mouse references. If not specified the GRCh38 human reference is automatically downladed and used.",
"fa_icon": "fas fa-folder-open",
"default": "https://cf.10xgenomics.com/supp/spatial-exp/refdata-gex-GRCh38-2020-A.tar.gz",
"exists": true
}
}
},
"optional_outputs": {
"title": "Optional outputs",
"type": "object",
"fa_icon": "fas fa-floppy-disk",
"description": "Additional intermediate output files that can be optionally saved.",
"properties": {
"spaceranger_save_reference": {
"type": "boolean",
"description": "Save the extracted tar archive of the Space Ranger reference.",
"help_text": "By default, extracted versions of archived Space Ranger reference data will not be saved to the results directory. Specify this flag (or set to true in your config file) to copy these files to the results directory when complete.",
"fa_icon": "fas fa-floppy-disk"
},
"save_untar_output": {
"type": "boolean",
"description": "Save extracted tar archives of input data.",
"help_text": "By default, extracted versions of archived input data will not be saved to the results directory. Specify this flag (or set to true in your config file) to copy these files to the results directory when complete.",
"fa_icon": "fas fa-floppy-disk"
}
}
},
"analysis_options": {
"title": "Analysis options",
"type": "object",
"fa_icon": "fas fa-magnifying-glass-chart",
"description": "Options related to the downstream analyses performed by the pipeline.",
"properties": {
"qc_min_counts": {
"type": "integer",
"default": 500,
"description": "The minimum number of UMIs needed in a spot for that spot to pass the filtering.",
"fa_icon": "fas fa-hashtag"
},
"qc_min_genes": {
"type": "integer",
"default": 250,
"description": "The minimum number of expressed genes in a spot needed for that spot to pass the filtering.",
"fa_icon": "fas fa-hashtag"
},
"qc_min_spots": {
"type": "integer",
"default": 1,
"description": "The minimum number of spots in which a gene is expressed for that gene to pass the filtering.",
"fa_icon": "fas fa-hashtag"
},
"qc_mito_threshold": {
"type": "number",
"default": 20,
"description": "The maximum proportion of mitochondrial content that a spot is allowed to have to pass the filtering.",
"help_text": "If you do not wish to filter based on mitochondrial content, set this parameter to `100`.",
"fa_icon": "fas fa-hashtag"
},
"qc_ribo_threshold": {
"type": "number",
"default": 0,
"description": "The minimum proportion of ribosomal content that a spot is needs to have to pass the filtering (no filtering is done by default).",
"fa_icon": "fas fa-hashtag"
},
"qc_hb_threshold": {
"type": "number",
"default": 100,
"description": "The maximum proportion of haemoglobin content that a spot is allowed to have to pass the filtering (no filtering is done by default).",
"fa_icon": "fas fa-hashtag"
},
"cluster_n_hvgs": {
"type": "integer",
"default": 2000,
"description": "The number of top highly variable genes to use for the analyses.",
"fa_icon": "fas fa-hashtag"
},
"cluster_resolution": {
"type": "number",
"default": 1,
"description": "The resolution for the clustering of the spots.",
"help_text": "The resolution controls the coarseness of the clustering, where a higher resolution leads to more clusters.",
"fa_icon": "fas fa-circle-nodes"
},
"svg_autocorr_method": {
"type": "string",
"default": "moran",
"description": "The method to use for spatially variable gene autocorrelation.",
"enum": ["moran", "geary"],
"fa_icon": "fas fa-circle-nodes"
},
"n_top_svgs": {
"type": "integer",
"default": 14,
"description": "The number of top spatially variable genes to plot.",
"fa_icon": "fas fa-hashtag"
}
}
},
"aggregation_options": {
"title": "Data aggregation options",
"type": "object",
"fa_icon": "fas fa-rocket",
"description": "Options related to aggregation of final data objects",
"properties": {
"merge_sdata": {
"type": "boolean",
"description": "Merge per-sample SpatialData objects into one.",
"fa_icon": "fas fa-arrows-to-dot"
},
"integrate_sdata": {
"type": "boolean",
"description": "Integrate per-sample SpatialData objects into one and output a integration report.",
"fa_icon": "fas fa-arrows-to-dot"
},
"integration_cluster_resolution": {
"type": "number",
"default": 1,
"description": "The resolution for the clustering of the spots after integration of samples.",
"help_text": "The resolution controls the coarseness of the clustering, where a higher resolution leads to more clusters.",
"fa_icon": "fas fa-circle-nodes"
},
"integration_n_hvgs": {
"type": "integer",
"default": 2000,
"description": "Number of highly variable genes to use for integration of samples.",
"fa_icon": "fas fa-hashtag"
}
}
},
"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"
},
"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 this parameter.",
"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"
}
}
},
"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": {
"version": {
"type": "boolean",
"description": "Display version and exit.",
"fa_icon": "fas fa-question-circle",
"hidden": true
},
"publish_dir_mode": {
"type": "string",
"default": "copy",
"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"],
"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})$",
"help_text": "An email address to send a summary email to when the pipeline is completed - ONLY sent if the pipeline does not exit successfully.",
"hidden": true
},
"plaintext_email": {
"type": "boolean",
"description": "Send plain-text email instead of HTML.",
"fa_icon": "fas fa-remove-format",
"hidden": true
},
"max_multiqc_email_size": {
"type": "string",
"description": "File size limit when attaching MultiQC reports to summary emails.",
"pattern": "^\\d+(\\.\\d+)?\\.?\\s*(K|M|G|T)?B$",
"default": "25.MB",
"fa_icon": "fas fa-file-upload",
"hidden": true
},
"monochrome_logs": {
"type": "boolean",
"description": "Do not use coloured log outputs.",
"fa_icon": "fas fa-palette",
"hidden": true
},
"hook_url": {
"type": "string",
"description": "Incoming hook URL for messaging service",
"fa_icon": "fas fa-people-group",
"help_text": "Incoming hook URL for messaging service. Currently, MS Teams and Slack are supported.",
"hidden": true
},
"multiqc_config": {
"type": "string",
"format": "file-path",
"description": "Custom config file to supply to MultiQC.",
"fa_icon": "fas fa-cog",
"hidden": true
},
"multiqc_logo": {
"type": "string",
"description": "Custom logo file to supply to MultiQC. File name must also be set in the MultiQC config file",
"fa_icon": "fas fa-image",
"hidden": true
},
"multiqc_methods_description": {
"type": "string",
"description": "Custom MultiQC yaml file containing HTML including a methods description.",
"fa_icon": "fas fa-cog"
},
"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
},
"pipelines_testdata_base_path": {
"type": "string",
"fa_icon": "far fa-check-circle",
"description": "Base URL or local path to location of pipeline test dataset files",
"default": "https://raw.githubusercontent.com/nf-core/test-datasets/",
"hidden": true
},
"trace_report_suffix": {
"type": "string",
"fa_icon": "far calendar",
"description": "Suffix to add to the trace report filename. Default is the date and time in the format yyyy-MM-dd_HH-mm-ss.",
"hidden": true
}
}
}
},
"allOf": [
{
"$ref": "#/$defs/input_output_options"
},
{
"$ref": "#/$defs/spaceranger_options"
},
{
"$ref": "#/$defs/optional_outputs"
},
{
"$ref": "#/$defs/analysis_options"
},
{
"$ref": "#/$defs/aggregation_options"
},
{
"$ref": "#/$defs/institutional_config_options"
},
{
"$ref": "#/$defs/generic_options"
}
]
}