Files
htrnaseq/target/nextflow/stats/combine_star_logs/nextflow_schema.json
CI a95268a2b5 Build branch main with version main (cb58990)
Build pipeline: viash-hub.htrnaseq.main-mjsqg

Source commit: cb58990a33

Source message: Fix create_report build after R update (#52)
2025-04-29 12:11:45 +00:00

112 lines
5.2 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema",
"title": "combine_star_logs",
"description": "No description",
"type": "object",
"definitions": {
"arguments" : {
"title": "Arguments",
"type": "object",
"description": "No description",
"properties": {
"barcodes": {
"type":
"string",
"description": "Type: List of `string`, required, multiple_sep: `\";\"`. Barcodes responding to the respective log files",
"help_text": "Type: List of `string`, required, multiple_sep: `\";\"`. Barcodes responding to the respective log files.\n"
}
,
"star_logs": {
"type":
"string",
"description": "Type: List of `file`, required, example: `Log.final.out`, multiple_sep: `\";\"`. Paths to the STAR log files (most frequently called Log",
"help_text": "Type: List of `file`, required, example: `Log.final.out`, multiple_sep: `\";\"`. Paths to the STAR log files (most frequently called Log.final.out)\n"
}
,
"gene_summary_logs": {
"type":
"string",
"description": "Type: List of `file`, required, example: `Summary.txt`, multiple_sep: `\";\"`. Paths to the Summary",
"help_text": "Type: List of `file`, required, example: `Summary.txt`, multiple_sep: `\";\"`. Paths to the Summary.csv files from the STAR Solo output. Can be found in\nthe \u0027Solo.out/Gene\u0027 folder relative to the root of the STAR output directory. \n"
}
,
"reads_per_gene_logs": {
"type":
"string",
"description": "Type: List of `file`, required, multiple_sep: `\";\"`. Paths to the \u0027ReadsPerGene",
"help_text": "Type: List of `file`, required, multiple_sep: `\";\"`. Paths to the \u0027ReadsPerGene.out.tab\u0027 files as output by STAR.\n"
}
,
"output": {
"type":
"string",
"description": "Type: `file`, default: `starLogs.txt`. Tab-delimited file describing for each barcode (as the rows), the metrics (as columns)\ngathered from the different input files",
"help_text": "Type: `file`, default: `starLogs.txt`. Tab-delimited file describing for each barcode (as the rows), the metrics (as columns)\ngathered from the different input files. \n"
,
"default":"starLogs.txt"
}
}
},
"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/arguments"
},
{
"$ref": "#/definitions/nextflow input-output arguments"
}
]
}