Files
rnaseq/target/nextflow/rseqc/rseqc_tin/nextflow_schema.json
CI 1ebb61f1e8 Build branch main with version main (1e1ffb3)
Build pipeline: vsh-ci-dev-jsbwk

Source commit: 1e1ffb315f

Source message: Merge pull request #17 from viash-hub/add_biobox_modules

- Migrate a number of components to biobox
- Fix tests
- Reduce size of test resources
- Prepare for Viash Hub
2024-09-13 07:41:13 +00:00

160 lines
6.3 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema",
"title": "rseqc_tin",
"description": "Calculte TIN (transcript integrity number) from RNA-seq reads\n",
"type": "object",
"definitions": {
"input" : {
"title": "Input",
"type": "object",
"description": "No description",
"properties": {
"bam_input": {
"type":
"string",
"description": "Type: `file`, required. Path to input alignment file in BAM or SAM format",
"help_text": "Type: `file`, required. Path to input alignment file in BAM or SAM format."
}
,
"bai_input": {
"type":
"string",
"description": "Type: `file`, required. Path to bam index file in bai format",
"help_text": "Type: `file`, required. Path to bam index file in bai format."
}
,
"refgene": {
"type":
"string",
"description": "Type: `file`, required. BED file containing the reference gene model",
"help_text": "Type: `file`, required. BED file containing the reference gene model"
}
,
"minimum_coverage": {
"type":
"integer",
"description": "Type: `integer`, default: `10`. Minimum number of reads mapped to a transcript, default = 10",
"help_text": "Type: `integer`, default: `10`. Minimum number of reads mapped to a transcript, default = 10."
,
"default": "10"
}
,
"sample_size": {
"type":
"integer",
"description": "Type: `integer`, default: `100`. Number of equal-spaced nucleotide positions picked from mRNA",
"help_text": "Type: `integer`, default: `100`. Number of equal-spaced nucleotide positions picked from mRNA. Note, if this number is larger than the length of mRNA (L), it will be halved until it\u0027s smaller than L (default = 100)"
,
"default": "100"
}
,
"subtract_background": {
"type":
"boolean",
"description": "Type: `boolean_true`, default: `false`. Set flag to subtract background noise (estimated from intronic reads)",
"help_text": "Type: `boolean_true`, default: `false`. Set flag to subtract background noise (estimated from intronic reads). Only use this option if there are substantial intronic reads."
,
"default": "False"
}
}
},
"output" : {
"title": "Output",
"type": "object",
"description": "No description",
"properties": {
"output_tin_summary": {
"type":
"string",
"description": "Type: `file`, default: `$id.$key.output_tin_summary.txt`. summary statistics (txt) of calculated TIN metrics",
"help_text": "Type: `file`, default: `$id.$key.output_tin_summary.txt`. summary statistics (txt) of calculated TIN metrics"
,
"default": "$id.$key.output_tin_summary.txt"
}
,
"output_tin": {
"type":
"string",
"description": "Type: `file`, default: `$id.$key.output_tin.xls`. file with TIN metrics (xls)",
"help_text": "Type: `file`, default: `$id.$key.output_tin.xls`. file with TIN metrics (xls)"
,
"default": "$id.$key.output_tin.xls"
}
}
},
"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"
}
]
}