From 7cee28e90a2bc7c18216029d1ee194eb78d0056c Mon Sep 17 00:00:00 2001 From: tgaspe Date: Fri, 30 Aug 2024 10:08:13 +0200 Subject: [PATCH] small changes in config file --- src/bcftools/bcftools_concat/config.vsh.yaml | 27 ++++++++++++-------- src/bcftools/bcftools_concat/script.sh | 2 +- 2 files changed, 17 insertions(+), 12 deletions(-) diff --git a/src/bcftools/bcftools_concat/config.vsh.yaml b/src/bcftools/bcftools_concat/config.vsh.yaml index 2636ba9b..a092c20f 100644 --- a/src/bcftools/bcftools_concat/config.vsh.yaml +++ b/src/bcftools/bcftools_concat/config.vsh.yaml @@ -21,7 +21,7 @@ requirements: commands: [bcftools] authors: - __merge__: /src/_authors/theodoro_gasperin.yaml - roles: [ author, maintainer ] + roles: [author] argument_groups: - name: Inputs @@ -98,7 +98,7 @@ argument_groups: Dangerous, use with caution. - name: --output_type - alternatives: --O + alternatives: -O type: string choices: ['u', 'z', 'b', 'v'] description: | @@ -117,24 +117,29 @@ argument_groups: - name: --regions alternatives: -r type: string - description: Restrict to comma-separated list of regions. + description: | + Restrict to comma-separated list of regions. + Following formats are supported: chr|chr:pos|chr:beg-end|chr:beg-[,…​]. + example: '20:1000000-2000000' - name: --regions_file alternatives: -R type: file - description: Restrict to regions listed in a file. + description: | + Restrict to regions listed in a file. + Regions can be specified either on a VCF, BED, or tab-delimited file (the default). + For more information check manual. - name: --regions_overlap type: string choices: ['pos', 'record', 'variant', '0', '1', '2'] description: | - Include if POS in the region (0), record overlaps (1), variant overlaps (2). - - - name: --threads - type: integer - description: | - Use multithreading with the specified number of worker threads. - + This option controls how overlapping records are determined: + set to 'pos' or '0' if the VCF record has to have POS inside a region (this corresponds to the default behavior of -t/-T); + set to 'record' or '1' if also overlapping records with POS outside a region should be included (this is the default behavior of -r/-R, + and includes indels with POS at the end of a region, which are technically outside the region); + or set to 'variant' or '2' to include only true overlapping variation (compare the full VCF representation "TA>T-" vs the true sequence variation "A>-"). + - name: --verbose alternatives: -v type: integer diff --git a/src/bcftools/bcftools_concat/script.sh b/src/bcftools/bcftools_concat/script.sh index d77e0615..df593a42 100644 --- a/src/bcftools/bcftools_concat/script.sh +++ b/src/bcftools/bcftools_concat/script.sh @@ -43,7 +43,7 @@ bcftools concat \ ${par_regions:+-r "$par_regions"} \ ${par_regions_file:+-R "$par_regions_file"} \ ${par_regions_overlap:+--regions-overlap "$par_regions_overlap"} \ - ${par_threads:+--threads "$par_threads"} \ + ${meta_cpus:+--threads "$meta_cpus"} \ ${par_verbose:+-v "$par_verbose"} \ -o $par_output \ ${input[@]} \ \ No newline at end of file