Files
biobox/target/nextflow/lofreq/lofreq_indelqual/nextflow_schema.json
CI 56a195f1bb Build branch v0.1 with version v0.1 (d97e315)
Build pipeline: vsh-ci-template-bbg2t

Source commit: d97e3156fe

Source message: Rename biobase -> biobox
2024-06-24 08:47:42 +00:00

152 lines
6.0 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema",
"title": "lofreq_indelqual",
"description": "Insert indel qualities into BAM file (required for indel predictions).\n\nThe preferred way of inserting indel qualities should be via GATK\u0027s BQSR (\u003e=2) If that\u0027s not possible, use this subcommand.\nThe command has two modes: \u0027uniform\u0027 and \u0027dindel\u0027:\n- \u0027uniform\u0027 will assign a given value uniformly, whereas\n- \u0027dindel\u0027 will insert indel qualities based on Dindel (PMID 20980555).\nBoth will overwrite any existing values.\nDo not realign your BAM file afterwards!\n",
"type": "object",
"definitions": {
"inputs" : {
"title": "Inputs",
"type": "object",
"description": "No description",
"properties": {
"input": {
"type":
"string",
"description": "Type: `file`, required, example: `normal.bam`. Input BAM file",
"help_text": "Type: `file`, required, example: `normal.bam`. Input BAM file.\n"
}
,
"ref": {
"type":
"string",
"description": "Type: `file`, example: `reference.fasta`. Reference sequence used for mapping (Only required for --dindel)",
"help_text": "Type: `file`, example: `reference.fasta`. Reference sequence used for mapping (Only required for --dindel).\n"
}
}
},
"outputs" : {
"title": "Outputs",
"type": "object",
"description": "No description",
"properties": {
"out": {
"type":
"string",
"description": "Type: `file`, required, default: `$id.$key.out.bam`, example: `output.bam`. Output BAM file",
"help_text": "Type: `file`, required, default: `$id.$key.out.bam`, example: `output.bam`. Output BAM file.\n"
,
"default": "$id.$key.out.bam"
}
}
},
"arguments" : {
"title": "Arguments",
"type": "object",
"description": "No description",
"properties": {
"uniform": {
"type":
"string",
"description": "Type: `string`, example: `50,50`. Add this indel quality uniformly to all bases",
"help_text": "Type: `string`, example: `50,50`. Add this indel quality uniformly to all bases. Use two comma separated values to specify insertion and deletion quality separately. (clashes with --dindel).\n"
}
,
"dindel": {
"type":
"boolean",
"description": "Type: `boolean_true`, default: `false`. Add Dindel\u0027s indel qualities (Illumina specific) (clashes with -u; needs --ref)",
"help_text": "Type: `boolean_true`, default: `false`. Add Dindel\u0027s indel qualities (Illumina specific) (clashes with -u; needs --ref).\n"
,
"default": "False"
}
,
"verbose": {
"type":
"boolean",
"description": "Type: `boolean_true`, default: `false`. Be verbose",
"help_text": "Type: `boolean_true`, default: `false`. Be verbose.\n"
,
"default": "False"
}
}
},
"nextflow input-output arguments" : {
"title": "Nextflow input-output arguments",
"type": "object",
"description": "Input/output parameters for Nextflow itself. Please note that both publishDir and publish_dir are supported but at least one has to be configured.",
"properties": {
"publish_dir": {
"type":
"string",
"description": "Type: `string`, required, example: `output/`. Path to an output directory",
"help_text": "Type: `string`, required, example: `output/`. Path to an output directory."
}
,
"param_list": {
"type":
"string",
"description": "Type: `string`, example: `my_params.yaml`. Allows inputting multiple parameter sets to initialise a Nextflow channel",
"help_text": "Type: `string`, example: `my_params.yaml`. Allows inputting multiple parameter sets to initialise a Nextflow channel. A `param_list` can either be a list of maps, a csv file, a json file, a yaml file, or simply a yaml blob.\n\n* A list of maps (as-is) where the keys of each map corresponds to the arguments of the pipeline. Example: in a `nextflow.config` file: `param_list: [ [\u0027id\u0027: \u0027foo\u0027, \u0027input\u0027: \u0027foo.txt\u0027], [\u0027id\u0027: \u0027bar\u0027, \u0027input\u0027: \u0027bar.txt\u0027] ]`.\n* A csv file should have column names which correspond to the different arguments of this pipeline. Example: `--param_list data.csv` with columns `id,input`.\n* A json or a yaml file should be a list of maps, each of which has keys corresponding to the arguments of the pipeline. Example: `--param_list data.json` with contents `[ {\u0027id\u0027: \u0027foo\u0027, \u0027input\u0027: \u0027foo.txt\u0027}, {\u0027id\u0027: \u0027bar\u0027, \u0027input\u0027: \u0027bar.txt\u0027} ]`.\n* A yaml blob can also be passed directly as a string. Example: `--param_list \"[ {\u0027id\u0027: \u0027foo\u0027, \u0027input\u0027: \u0027foo.txt\u0027}, {\u0027id\u0027: \u0027bar\u0027, \u0027input\u0027: \u0027bar.txt\u0027} ]\"`.\n\nWhen passing a csv, json or yaml file, relative path names are relativized to the location of the parameter file. No relativation is performed when `param_list` is a list of maps (as-is) or a yaml blob.",
"hidden": true
}
}
}
},
"allOf": [
{
"$ref": "#/definitions/inputs"
},
{
"$ref": "#/definitions/outputs"
},
{
"$ref": "#/definitions/arguments"
},
{
"$ref": "#/definitions/nextflow input-output arguments"
}
]
}