Files
htrnaseq/target/nextflow/workflows/well_metadata/nextflow_schema.json
CI 46e39d2b9b Build branch v0.7 with version v0.7.1 (28baa17)
Build pipeline: viash-hub.htrnaseq.v0.7-gvsx6

Source commit: 28baa17391

Source message: Bump version to v0.7.1
2025-04-30 11:26:58 +00:00

188 lines
6.5 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema",
"title": "well_metadata",
"description": "No description",
"type": "object",
"definitions": {
"input arguments" : {
"title": "Input arguments",
"type": "object",
"description": "No description",
"properties": {
"input_r1": {
"type":
"string",
"description": "Type: List of `file`, required, multiple_sep: `\";\"`. List of FASTQ files for the forward reads, 1 per well",
"help_text": "Type: List of `file`, required, multiple_sep: `\";\"`. List of FASTQ files for the forward reads, 1 per well.\n"
}
,
"input_r2": {
"type":
"string",
"description": "Type: List of `file`, required, multiple_sep: `\";\"`. List of FASTQ files for the forward reads, 1 per well",
"help_text": "Type: List of `file`, required, multiple_sep: `\";\"`. List of FASTQ files for the forward reads, 1 per well.\n"
}
,
"star_mapping": {
"type":
"string",
"description": "Type: List of `file`, required, multiple_sep: `\";\"`. ",
"help_text": "Type: List of `file`, required, multiple_sep: `\";\"`. "
}
,
"barcodesFasta": {
"type":
"string",
"description": "Type: `file`, required. ",
"help_text": "Type: `file`, required. "
}
}
},
"output arguments" : {
"title": "Output arguments",
"type": "object",
"description": "No description",
"properties": {
"output_r1": {
"type":
"string",
"description": "Type: `file`, required, default: `$id.$key.output_r1`. Output fastq file",
"help_text": "Type: `file`, required, default: `$id.$key.output_r1`. Output fastq file."
,
"default":"$id.$key.output_r1"
}
,
"output_r2": {
"type":
"string",
"description": "Type: `file`, required, default: `$id.$key.output_r2`. Output fastq file",
"help_text": "Type: `file`, required, default: `$id.$key.output_r2`. Output fastq file."
,
"default":"$id.$key.output_r2"
}
,
"pool": {
"type":
"string",
"description": "Type: `string`. The original pool / sample name",
"help_text": "Type: `string`. The original pool / sample name"
}
,
"well_id": {
"type":
"string",
"description": "Type: `string`. ",
"help_text": "Type: `string`. "
}
,
"barcode": {
"type":
"string",
"description": "Type: `string`. ",
"help_text": "Type: `string`. "
}
,
"n_wells": {
"type":
"integer",
"description": "Type: `integer`. The number of wells in the pool is well is a part of",
"help_text": "Type: `integer`. The number of wells in the pool is well is a part of."
}
,
"well_star_mapping": {
"type":
"string",
"description": "Type: `file`, default: `$id.$key.well_star_mapping`. ",
"help_text": "Type: `file`, default: `$id.$key.well_star_mapping`. "
,
"default":"$id.$key.well_star_mapping"
}
}
},
"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 arguments"
},
{
"$ref": "#/definitions/output arguments"
},
{
"$ref": "#/definitions/nextflow input-output arguments"
}
]
}