Files
openpipeline/target/nextflow/genetic_demux/scsplit/nextflow_schema.json
CI bb7533583f Build branch fix-integration-tests with version fix-integration-tests (da62b4ff)
Build pipeline: vsh-ci-dev-gckj5

Source commit: da62b4ffe3

Source message: Add labels to qc_test component
2024-11-15 14:37:33 +00:00

230 lines
8.0 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema",
"title": "scsplit",
"description": "scsplit is a genotype-free demultiplexing methode of pooled single-cell RNA-seq, using a hidden state model for identifying genetically distinct samples within a mixed population.",
"type": "object",
"definitions": {
"input" : {
"title": "Input",
"type": "object",
"description": "No description",
"properties": {
"vcf": {
"type":
"string",
"description": "Type: `file`. VCF from mixed BAM",
"help_text": "Type: `file`. VCF from mixed BAM"
}
,
"bam": {
"type":
"string",
"description": "Type: `file`. mixed sample BAM",
"help_text": "Type: `file`. mixed sample BAM"
}
,
"bar": {
"type":
"string",
"description": "Type: `file`. barcodes whitelist",
"help_text": "Type: `file`. barcodes whitelist"
}
,
"tag": {
"type":
"string",
"description": "Type: `string`, default: `CB`. tag for barcode",
"help_text": "Type: `string`, default: `CB`. tag for barcode"
,
"default": "CB"
}
,
"com": {
"type":
"string",
"description": "Type: `file`. common SNVs",
"help_text": "Type: `file`. common SNVs"
}
,
"num": {
"type":
"integer",
"description": "Type: `integer`. expected number of mixed samples",
"help_text": "Type: `integer`. expected number of mixed samples"
}
,
"sub": {
"type":
"integer",
"description": "Type: `integer`, default: `10`. maximum number of subpopulations in autodetect mode",
"help_text": "Type: `integer`, default: `10`. maximum number of subpopulations in autodetect mode"
,
"default": "10"
}
,
"ems": {
"type":
"integer",
"description": "Type: `integer`, default: `30`. number of EM repeats to avoid local maximum",
"help_text": "Type: `integer`, default: `30`. number of EM repeats to avoid local maximum"
,
"default": "30"
}
,
"dbl": {
"type":
"number",
"description": "Type: `double`. correction for doublets",
"help_text": "Type: `double`. correction for doublets. There will be no refinement on the results if this optional parameter is not specified or specified percentage is less than doublet rates detected during the run."
}
,
"vcf_known": {
"type":
"string",
"description": "Type: `file`. known individual genotypes to limit distinguishing variants to available variants, so that users do not need to redo genotyping on selected variants, otherwise any variants could be selected as distinguishing variants",
"help_text": "Type: `file`. known individual genotypes to limit distinguishing variants to available variants, so that users do not need to redo genotyping on selected variants, otherwise any variants could be selected as distinguishing variants."
}
,
"geno": {
"type":
"boolean",
"description": "Type: `boolean_true`, default: `false`. generate sample genotypes based on the split result",
"help_text": "Type: `boolean_true`, default: `false`. generate sample genotypes based on the split result."
,
"default": "False"
}
}
},
"output" : {
"title": "Output",
"type": "object",
"description": "No description",
"properties": {
"output": {
"type":
"string",
"description": "Type: `file`, default: `$id.$key.output.output`, example: `scSplit_out`. Output directory",
"help_text": "Type: `file`, default: `$id.$key.output.output`, example: `scSplit_out`. Output directory"
,
"default": "$id.$key.output.output"
}
,
"ref": {
"type":
"string",
"description": "Type: `string`. output Ref count matrix",
"help_text": "Type: `string`. output Ref count matrix"
}
,
"alt": {
"type":
"string",
"description": "Type: `string`. output Alt count matrix",
"help_text": "Type: `string`. output Alt count matrix"
}
,
"psc": {
"type":
"string",
"description": "Type: `string`. generated P(S|C)",
"help_text": "Type: `string`. generated P(S|C)"
}
}
},
"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/input"
},
{
"$ref": "#/definitions/output"
},
{
"$ref": "#/definitions/nextflow input-output arguments"
}
]
}