Files
biobox/target/nextflow/fq_subsample/nextflow_schema.json
CI 47c9784250 Build branch v0.3 with version v0.3.0 (d86bd5c)
Build pipeline: viash-hub.biobox.v0.3-cl68g

Source commit: d86bd5cf62

Source message: Merge remote-tracking branch 'origin/main' into v0.3
2024-12-03 11:09:46 +00:00

161 lines
5.8 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema",
"title": "fq_subsample",
"description": "fq subsample outputs a subset of records from single or paired FASTQ files.",
"type": "object",
"definitions": {
"input" : {
"title": "Input",
"type": "object",
"description": "No description",
"properties": {
"input_1": {
"type":
"string",
"description": "Type: `file`, required. First input fastq file to subsample",
"help_text": "Type: `file`, required. First input fastq file to subsample. Accepts both raw and gzipped FASTQ inputs."
}
,
"input_2": {
"type":
"string",
"description": "Type: `file`. Second input fastq files to subsample",
"help_text": "Type: `file`. Second input fastq files to subsample. Accepts both raw and gzipped FASTQ inputs."
}
}
},
"output" : {
"title": "Output",
"type": "object",
"description": "No description",
"properties": {
"output_1": {
"type":
"string",
"description": "Type: `file`, default: `$id.$key.output_1.output_1`. Sampled read 1 fastq files",
"help_text": "Type: `file`, default: `$id.$key.output_1.output_1`. Sampled read 1 fastq files. Output will be gzipped if ends in `.gz`."
,
"default":"$id.$key.output_1.output_1"
}
,
"output_2": {
"type":
"string",
"description": "Type: `file`, default: `$id.$key.output_2.output_2`. Sampled read 2 fastq files",
"help_text": "Type: `file`, default: `$id.$key.output_2.output_2`. Sampled read 2 fastq files. Output will be gzipped if ends in `.gz`."
,
"default":"$id.$key.output_2.output_2"
}
}
},
"options" : {
"title": "Options",
"type": "object",
"description": "No description",
"properties": {
"probability": {
"type":
"number",
"description": "Type: `double`. The probability a record is kept, as a percentage (0",
"help_text": "Type: `double`. The probability a record is kept, as a percentage (0.0, 1.0). Cannot be used with `record-count`"
}
,
"record_count": {
"type":
"integer",
"description": "Type: `integer`. The exact number of records to keep",
"help_text": "Type: `integer`. The exact number of records to keep. Cannot be used with `probability`"
}
,
"seed": {
"type":
"integer",
"description": "Type: `integer`. Seed to use for the random number generator",
"help_text": "Type: `integer`. Seed to use for the random number generator"
}
}
},
"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/options"
},
{
"$ref": "#/definitions/nextflow input-output arguments"
}
]
}