biobox/target/nextflow/samtools/samtools_collate/nextflow_schema.json

{
"$schema": "http://json-schema.org/draft-07/schema",
"title": "samtools_collate",
"description": "Shuffles and groups reads in SAM/BAM/CRAM files together by their names.",
"type": "object",
"definitions": {

    
    
    "inputs" : {
    "title": "Inputs",
    "type": "object",
    "description": "No description",
    "properties": {
    
        
                "input": {
                "type":
                "string",
                "description": "Type: `file`, required. The input BAM file",
                "help_text": "Type: `file`, required. The input BAM file."
            
            }
    

        ,
                "reference": {
                "type":
                "string",
                "description": "Type: `file`. Reference sequence FASTA FILE",
                "help_text": "Type: `file`. Reference sequence FASTA FILE."
            
            }
    

}
},
    
    
    "outputs" : {
    "title": "Outputs",
    "type": "object",
    "description": "No description",
    "properties": {
    
        
                "output": {
                "type":
                "string",
                "description": "Type: `file`, required, default: `$id.$key.output.output`. The output filename",
                "help_text": "Type: `file`, required, default: `$id.$key.output.output`. The output filename."
            ,
                "default": "$id.$key.output.output"
            }
    

}
},
    
    
    "options" : {
    "title": "Options",
    "type": "object",
    "description": "No description",
    "properties": {
    
        
                "uncompressed": {
                "type":
                "boolean",
                "description": "Type: `boolean_true`, default: `false`. Output uncompressed BAM",
                "help_text": "Type: `boolean_true`, default: `false`. Output uncompressed BAM."
            ,
                "default": "False"
            }
    

        ,
                "fast": {
                "type":
                "boolean",
                "description": "Type: `boolean_true`, default: `false`. Fast mode, only primary alignments",
                "help_text": "Type: `boolean_true`, default: `false`. Fast mode, only primary alignments."
            ,
                "default": "False"
            }
    

        ,
                "working_reads": {
                "type":
                "integer",
                "description": "Type: `integer`, default: `10000`. Working reads stored (for use with -f)",
                "help_text": "Type: `integer`, default: `10000`. Working reads stored (for use with -f)."
            ,
                "default": "10000"
            }
    

        ,
                "compression": {
                "type":
                "integer",
                "description": "Type: `integer`, default: `1`. Compression level",
                "help_text": "Type: `integer`, default: `1`. Compression level."
            ,
                "default": "1"
            }
    

        ,
                "nb_tmp_files": {
                "type":
                "integer",
                "description": "Type: `integer`, default: `64`. Number of temporary files",
                "help_text": "Type: `integer`, default: `64`. Number of temporary files."
            ,
                "default": "64"
            }
    

        ,
                "tmp_prefix": {
                "type":
                "string",
                "description": "Type: `string`. Write temporary files to PREFIX",
                "help_text": "Type: `string`. Write temporary files to PREFIX.nnnn.bam."
            
            }
    

        ,
                "no_pg": {
                "type":
                "boolean",
                "description": "Type: `boolean_true`, default: `false`. Do not add a PG line",
                "help_text": "Type: `boolean_true`, default: `false`. Do not add a PG line."
            ,
                "default": "False"
            }
    

        ,
                "input_fmt_option": {
                "type":
                "string",
                "description": "Type: `string`. Specify a single input file format option in the form of OPTION or OPTION=VALUE",
                "help_text": "Type: `string`. Specify a single input file format option in the form of OPTION or OPTION=VALUE."
            
            }
    

        ,
                "output_fmt": {
                "type":
                "string",
                "description": "Type: `string`. Specify output format (SAM, BAM, CRAM)",
                "help_text": "Type: `string`. Specify output format (SAM, BAM, CRAM)."
            
            }
    

        ,
                "output_fmt_option": {
                "type":
                "string",
                "description": "Type: `string`. Specify a single output file format option in the form of OPTION or OPTION=VALUE",
                "help_text": "Type: `string`. Specify a single output file format option in the form of OPTION or OPTION=VALUE."
            
            }
    

}
},
    
    
    "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/inputs"
    },

    {
    "$ref": "#/definitions/outputs"
    },

    {
    "$ref": "#/definitions/options"
    },

    {
    "$ref": "#/definitions/nextflow input-output arguments"
    }
]
}