annotate bcftools_plugin_mendelian.xml @ 25:6294f7c049f0 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
author iuc
date Tue, 02 Dec 2025 07:50:43 +0000
parents 2776dd881da8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18
e5c156768764 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit db275932cbb485cb44ae91e0b421d6f57698db49
iuc
parents: 16
diff changeset
1 <tool name="bcftools @EXECUTABLE@" id="bcftools_plugin_@PLUGIN_ID@" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
0
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
2 <description>plugin Count Mendelian consistent / inconsistent genotypes</description>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
3 <macros>
25
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
4 <token name="@EXECUTABLE@">mendelian2</token>
0
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
5 <token name="@PLUGIN_ID@">mendelian</token>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
6 <import>macros.xml</import>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
7 </macros>
25
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
8 <expand macro="bio_tools" />
0
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
9 <expand macro="requirements" />
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
10 <expand macro="version_command" />
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
11 <command detect_errors="aggressive"><![CDATA[
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
12 @PREPARE_INPUT_FILE@
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
13 #set $section = $sec_restrict
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
14 @PREPARE_TARGETS_FILE@
5
8fa5f4cf9797 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 10853682ffb2e9776256bb63c899ef5c5fe0007e
iuc
parents: 4
diff changeset
15 @PREPARE_REGIONS_FILE@
0
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
16
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
17 bcftools plugin @EXECUTABLE@
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
18
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
19 ## VCF input section
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
20 #set $section = $sec_restrict
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
21 @INCLUDE@
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
22 @EXCLUDE@
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
23 @REGIONS@
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
24 @TARGETS@
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
25
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
26 @OUTPUT_TYPE@
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
27
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
28 ## Primary Input/Outputs
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
29 @INPUT_FILE@
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
30
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
31 ## Plugin section
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
32 #set $section = $sec_plugin
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
33 #if $section.trios.trios_src == 'trio':
25
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
34 --pfm '${section.trios.num_x}:${section.trios.child},${section.trios.mother},${section.trios.father}'
0
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
35 #elif $section.trios.trios_src == 'trio_file':
25
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
36 --ped '$section.trios.trio_file'
0
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
37 #end if
25
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
38 #set $modes = "".join(str($section.mode).split(','))
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
39 -m $modes
0
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
40 2> tmp_stderr
5
8fa5f4cf9797 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 10853682ffb2e9776256bb63c899ef5c5fe0007e
iuc
parents: 4
diff changeset
41 > '$output_file'
0
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
42 && cat tmp_stderr
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
43 ]]>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
44 </command>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
45 <inputs>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
46 <expand macro="macro_input" />
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
47 <section name="sec_restrict" expanded="false" title="Restrict to">
25
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
48 <expand macro="macro_region_restrict" />
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
49 <expand macro="macro_target_restrict" />
0
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
50 <expand macro="macro_include" />
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
51 <expand macro="macro_exclude" />
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
52 </section>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
53 <section name="sec_plugin" expanded="true" title="Plugin Options">
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
54 <!-- trios -->
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
55 <conditional name="trios">
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
56 <param name="trios_src" type="select" label="Sample relationship">
25
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
57 <option value="trio">trio - mother,father,child (--pfm)</option>
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
58 <option value="trio_file">trios file - specify 1 or more trios in PED format (--ped)</option>
0
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
59 </param>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
60 <when value="trio">
25
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
61 <param name="mother" type="text" value="" label="Mother sample name (as it appears in the input)"/>
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
62 <param name="father" type="text" value="" label="Father sample name (as it appears in the input)"/>
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
63 <param name="child" type="text" value="" label="Child sample name (as it appears in the input)"/>
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
64 <param name="num_x" type="boolean" truevalue="1X" falsevalue="2X" label="Male child?" help="This information is used to judge inheritance patterns of X-chromosomal mutations correctly."/>
0
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
65 </when>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
66 <when value="trio_file">
25
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
67 <param name="trio_file" type="data" format="tabular" label="Sample information in PED format" help="This input dataset can describe one or several family trios. See the tool help below for more information on PED format." />
0
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
68 </when>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
69 </conditional>
25
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
70 <param name="mode" type="select" multiple="true" optional="false" label="Output mode" help="Output mode. Multiple modes can be combined and the drop modes take precedence.">
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
71 <option value="a" selected="true">add INFO -> MERR annotation with the number of inconsistent trios (a)</option>
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
72 <option value="d">delete (i.e., set to "./.") genotypes in inconsistent trios (d)</option>
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
73 <option value="e">output sites with at least one erroneous trio (e)</option>
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
74 <option value="E">drop sites with at least one erroneous trio (E)</option>
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
75 <option value="g">output sites with at least one good (i.e. with non-missing and consistent genotypes) trio (g)</option>
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
76 <option value="m">output sites with missing genotypes in at least one trio (m)</option>
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
77 <option value="M">drop sites with missing genotypes in at least one trio (M)</option>
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
78 <option value="S">drop sites skipped for various reasons when collecting stats (S)</option>
0
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
79 </param>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
80 </section>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
81 <expand macro="macro_select_output_type" />
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
82 </inputs>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
83 <outputs>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
84 <expand macro="macro_vcf_output" />
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
85 </outputs>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
86 <tests>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
87 <test>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
88 <!-- This is just a test on a random file, should have a real test case -->
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
89 <param name="input_file" ftype="vcf" value="convert.vcf" />
25
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
90 <section name="sec_plugin">
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
91 <conditional name="trios">
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
92 <param name="trios_src" value="trio" />
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
93 <param name="mother" value="NA00001" />
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
94 <param name="father" value="NA00002" />
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
95 <param name="child" value="NA00006" />
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
96 </conditional>
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
97 <param name="mode" value="d" />
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
98 </section>
0
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
99 <param name="output_type" value="v" />
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
100 <output name="output_file">
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
101 <assert_contents>
5
8fa5f4cf9797 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 10853682ffb2e9776256bb63c899ef5c5fe0007e
iuc
parents: 4
diff changeset
102 <has_text_matching expression="X\t2698769\t.\tAAG\tA\t999\t.\t.\tGT:PL:GP\t./."/>
0
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
103 </assert_contents>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
104 </output>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
105 </test>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
106 <test>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
107 <!-- This is just a test on a random file, should have a real test case -->
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
108 <param name="input_file" ftype="vcf" value="convert.vcf" />
25
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
109 <section name="sec_plugin">
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
110 <conditional name="trios">
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
111 <param name="trios_src" value="trio" />
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
112 <param name="mother" value="NA00001" />
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
113 <param name="father" value="NA00002" />
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
114 <param name="child" value="NA00006" />
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
115 </conditional>
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
116 <param name="mode" value="e" />
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
117 </section>
0
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
118 <param name="output_type" value="v" />
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
119 <output name="output_file">
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
120 <assert_contents>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
121 <not_has_text text="2698758" />
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
122 <has_text text="2698769" />
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
123 </assert_contents>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
124 </output>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
125 </test>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
126 </tests>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
127
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
128 <help><![CDATA[
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
129 =====================================
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
130 bcftools @EXECUTABLE@ plugin
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
131 =====================================
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
132
25
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
133
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
134 Describing sample relationships (family trios) in PED format
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
135 ------------------------------------------------------------
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
136
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
137 A PED file is simply a tabular text file (columns can be separated by either
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
138 spaces or TABs, but not a mixture of the two within the same file) with the
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
139 header::
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
140
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
141 #family_id name paternal_id maternal_id sex
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
142
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
143 and optional additional columns. The actual column names in the header are not
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
144 fixed, but there have to be at least six columns that are interpreted as
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
145 detailed next.
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
146
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
147 Subsequent lines describe one sample from the VCF input dataset each, where
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
148
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
149 - *family_id* is an alphanumeric identifier of a family
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
150
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
151 This column has to be present, but is ignored by this plugin
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
152
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
153 - *name* is the identifier of the sample described by the line
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
154
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
155 - *paternal_id* is the identifier of the sample's father
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
156
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
157 - *maternal_id* is the identifier of the sample's mother
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
158
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
159 - *sex* is a numeric code (1=male, 2=female) for the sample's sex
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
160
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
161 An example minimal PED file describing a single family-trio with a female child could look like this::
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
162
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
163 #family_id name paternal_id maternal_id sex
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
164 0 NA00001 0 0 1
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
165 0 NA00002 0 0 2
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
166 0 NA00003 NA00001 NA00002 2
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
167
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
168 where 0 is used as a placeholder for the paternal_id/maternal_id values in the records of the father and mother.
6294f7c049f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/bcftools commit f6efda26965eb73c9107d367fd5ffdf246ed0dbc
iuc
parents: 24
diff changeset
169
0
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
170 @REGIONS_HELP@
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
171 @TARGETS_HELP@
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
172 @EXPRESSIONS_HELP@
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
173
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
174 ]]></help>
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
175 <expand macro="citations" />
00fef0e241d3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
176 </tool>