Files
toolbox/target/nextflow/bgzip/nextflow_schema.json
CI 13b6d2421b Build branch check-resources with version check-resources (cfc11db)
Build pipeline: viash-hub.toolbox.check-resources-cxbsm

Source commit: cfc11db17d

Source message: add changelog entry
2025-06-24 09:12:25 +00:00

128 lines
4.2 KiB
JSON

{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "bgzip",
"description": "Block compression/decompression utility",
"type": "object",
"$defs": {
"inputs": {
"title": "Inputs",
"type": "object",
"description": "No description",
"properties": {
"input": {
"type": "string",
"format": "path",
"exists": true,
"description": "file to be compressed or decompressed",
"help_text": "Type: `file`, multiple: `False`, required, direction: `input`. "
}
}
},
"outputs": {
"title": "Outputs",
"type": "object",
"description": "No description",
"properties": {
"output": {
"type": "string",
"format": "path",
"description": "compressed or decompressed output",
"help_text": "Type: `file`, multiple: `False`, required, default: `\"$id.$key.output\"`, direction: `output`. ",
"default": "$id.$key.output"
},
"index_name": {
"type": "string",
"format": "path",
"description": "name of BGZF index file [file.gz.gzi]",
"help_text": "Type: `file`, multiple: `False`, default: `\"$id.$key.index_name\"`, direction: `output`. ",
"default": "$id.$key.index_name"
}
}
},
"arguments": {
"title": "Arguments",
"type": "object",
"description": "No description",
"properties": {
"offset": {
"type": "integer",
"description": "decompress at virtual file pointer (0-based uncompressed offset)",
"help_text": "Type: `integer`, multiple: `False`. "
},
"decompress": {
"type": "boolean",
"description": "decompress the input file",
"help_text": "Type: `boolean_true`, multiple: `False`, default: `false`. ",
"default": false
},
"rebgzip": {
"type": "boolean",
"description": "use an index file to bgzip a file",
"help_text": "Type: `boolean_true`, multiple: `False`, default: `false`. ",
"default": false
},
"index": {
"type": "boolean",
"description": "compress and create BGZF index",
"help_text": "Type: `boolean_true`, multiple: `False`, default: `false`. ",
"default": false
},
"compress_level": {
"type": "integer",
"description": "compression level to use when compressing; 0 to 9, or -1 for default [-1]",
"help_text": "Type: `integer`, multiple: `False`. "
},
"reindex": {
"type": "boolean",
"description": "(re)index the output file",
"help_text": "Type: `boolean_true`, multiple: `False`, default: `false`. ",
"default": false
},
"size": {
"type": "integer",
"description": "decompress INT bytes (uncompressed size)",
"help_text": "Type: `integer`, multiple: `False`. "
},
"test": {
"type": "boolean",
"description": "test integrity of compressed file",
"help_text": "Type: `boolean_true`, multiple: `False`, default: `false`. ",
"default": false
},
"binary": {
"type": "boolean",
"description": "Don't align blocks with text lines",
"help_text": "Type: `boolean_true`, multiple: `False`, default: `false`. ",
"default": false
}
}
},
"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": "Path to an output directory.",
"help_text": "Type: `string`, multiple: `False`, required, example: `\"output/\"`. "
}
}
}
},
"allOf": [
{
"$ref": "#/$defs/inputs"
},
{
"$ref": "#/$defs/outputs"
},
{
"$ref": "#/$defs/arguments"
},
{
"$ref": "#/$defs/nextflow input-output arguments"
}
]
}