feat: Add parameter schema
This commit is contained in:
parent
a5e2528781
commit
b415c29ec0
GPG key ID:
09335146883990B9
1 changed files with 166 additions and 0 deletions
166
nextflow_schema.json
Normal file
166
nextflow_schema.json
Normal file
|
|
@ -0,0 +1,166 @@
|
|||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema",
|
||||
"$id": "https://raw.githubusercontent.com/./master/nextflow_schema.json",
|
||||
"title": ". pipeline parameters",
|
||||
"description": "",
|
||||
"type": "object",
|
||||
"definitions": {
|
||||
"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", "reference", "outdir"],
|
||||
"properties": {
|
||||
"input": {
|
||||
"type": "string",
|
||||
"format": "file-path",
|
||||
"exists": true,
|
||||
"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 3 columns, and a header row.",
|
||||
"fa_icon": "fas fa-file-csv"
|
||||
},
|
||||
"reference": {
|
||||
"type": "string",
|
||||
"fa_icon": "fas fa-dna",
|
||||
"description": "NCBI accession number of the reference genome to align reads against",
|
||||
"pattern": "^[:upper:]{2}_[:digit:]{6}\\.[:digit:]+$"
|
||||
},
|
||||
"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"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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+(\\.\\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+\\.?\\s*(s|m|h|d|day)\\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'`"
|
||||
}
|
||||
}
|
||||
},
|
||||
"control_flow": {
|
||||
"title": "Control Flow",
|
||||
"type": "object",
|
||||
"description": "",
|
||||
"default": "",
|
||||
"fa_icon": "fas fa-toggle-on",
|
||||
"properties": {
|
||||
"cliquesnv": {
|
||||
"type": "boolean",
|
||||
"default": true
|
||||
},
|
||||
"haplink": {
|
||||
"type": "boolean",
|
||||
"default": true
|
||||
},
|
||||
"quasirecomb": {
|
||||
"type": "boolean",
|
||||
"default": true
|
||||
},
|
||||
"shorah": {
|
||||
"type": "boolean",
|
||||
"default": true
|
||||
},
|
||||
"viquas": {
|
||||
"type": "boolean",
|
||||
"default": true
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/input_output_options"
|
||||
},
|
||||
{
|
||||
"$ref": "#/definitions/institutional_config_options"
|
||||
},
|
||||
{
|
||||
"$ref": "#/definitions/max_job_request_options"
|
||||
},
|
||||
{
|
||||
"$ref": "#/definitions/control_flow"
|
||||
}
|
||||
]
|
||||
}
|
||||
Loading…
Reference in a new issue