Skip to content

Commit

Permalink
Fix Nextflow schema file
Browse files Browse the repository at this point in the history
- Remove duplicate parameters
- Remove non-existent parameters
- Remove empty groups
- Reorder, add description, add icons
  • Loading branch information
ewels committed Jul 18, 2023
1 parent 88b8ef8 commit f4b4da9
Showing 1 changed file with 15 additions and 61 deletions.
76 changes: 15 additions & 61 deletions nextflow_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,82 +11,36 @@
"fa_icon": "fas fa-terminal",
"description": "Define where the pipeline should find input data and save output data.",
"properties": {
"transcriptome": {
"type": "string",
"description": "The input transcriptome file",
"fa_icon": "fas fa-folder-open"
},
"reads": {
"type": "string",
"description": "The input read-pair files",
"fa_icon": "fas fa-folder-open"
"fa_icon": "fas fa-inbox-in"
},
"transcriptome": {
"type": "string",
"description": "The input transcriptome file",
"fa_icon": "fas fa-dna",
"format": "file-path",
"mimetype": "text/fasta"
},
"outdir": {
"type": "string",
"description": "The output directory where the results will be saved.",
"default": "./results",
"fa_icon": "fas fa-folder-open"
},
"multiqc": {
"type": "string",
"description": "MultiQC assets folder",
"fa_icon": "fas fa-gear",
"format": "directory-path"
}
}
},
"reference_genome_options": {
"title": "Reference genome options",
"type": "object",
"fa_icon": "fas fa-dna",
"description": "Options for the reference genome indices used to align reads.",
"properties": {}
},
"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": {}
},
"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": {}
},
"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": {}
}
},
"allOf": [
{
"$ref": "#/definitions/input_output_options"
},
{
"$ref": "#/definitions/reference_genome_options"
},
{
"$ref": "#/definitions/generic_options"
},
{
"$ref": "#/definitions/max_job_request_options"
},
{
"$ref": "#/definitions/institutional_config_options"
}
],
"properties": {
"reads": {
"type": "string"
},
"transcriptome": {
"type": "string"
},
"multiqc": {
"type": "string"
}
}
]
}

0 comments on commit f4b4da9

Please sign in to comment.