annotate cfsan_snp_pipeline_merge_sites.xml @ 0:201984e0cab2 draft

Uploaded
author greg
date Fri, 13 Oct 2023 14:20:19 +0000
parents
children 1013b32b325a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
201984e0cab2 Uploaded
greg
parents:
diff changeset
1 <tool id="cfsan_snp_pipeline_merge_sites" name="CFSAN SNP Pipeline: merge sites" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
201984e0cab2 Uploaded
greg
parents:
diff changeset
2 <description>from multiple samples</description>
201984e0cab2 Uploaded
greg
parents:
diff changeset
3 <macros>
201984e0cab2 Uploaded
greg
parents:
diff changeset
4 <import>macros.xml</import>
201984e0cab2 Uploaded
greg
parents:
diff changeset
5 </macros>
201984e0cab2 Uploaded
greg
parents:
diff changeset
6 <expand macro="requirements"/>
201984e0cab2 Uploaded
greg
parents:
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
201984e0cab2 Uploaded
greg
parents:
diff changeset
8 python '$__tool_directory__/snp_wind.py' ./
201984e0cab2 Uploaded
greg
parents:
diff changeset
9 #if str($input_type_cond.input_type) == 'single':
201984e0cab2 Uploaded
greg
parents:
diff changeset
10 -n '$input_vcf.element_identifier'
201984e0cab2 Uploaded
greg
parents:
diff changeset
11 -f '$input_vcf'
201984e0cab2 Uploaded
greg
parents:
diff changeset
12 #else:
201984e0cab2 Uploaded
greg
parents:
diff changeset
13 #for $input_vcf in $input_vcf_collection
201984e0cab2 Uploaded
greg
parents:
diff changeset
14 -n '$input_vcf.element_identifier'
201984e0cab2 Uploaded
greg
parents:
diff changeset
15 -f '$input_vcf'
201984e0cab2 Uploaded
greg
parents:
diff changeset
16 #end for
201984e0cab2 Uploaded
greg
parents:
diff changeset
17 #end if
201984e0cab2 Uploaded
greg
parents:
diff changeset
18 -p 'var.fit.vcf' > ./file
201984e0cab2 Uploaded
greg
parents:
diff changeset
19 && cfsan_snp_pipeline merge_sites -v 4 -n 'var.fit.vcf' ./file ./filtered_snps -o '$output'
201984e0cab2 Uploaded
greg
parents:
diff changeset
20 ]]></command>
201984e0cab2 Uploaded
greg
parents:
diff changeset
21 <inputs>
201984e0cab2 Uploaded
greg
parents:
diff changeset
22 <expand macro="input_type_cond"/>
201984e0cab2 Uploaded
greg
parents:
diff changeset
23 </inputs>
201984e0cab2 Uploaded
greg
parents:
diff changeset
24 <outputs>
201984e0cab2 Uploaded
greg
parents:
diff changeset
25 <data name="output" format="tabular"/>
201984e0cab2 Uploaded
greg
parents:
diff changeset
26 </outputs>
201984e0cab2 Uploaded
greg
parents:
diff changeset
27 <tests>
201984e0cab2 Uploaded
greg
parents:
diff changeset
28 <test>
201984e0cab2 Uploaded
greg
parents:
diff changeset
29 <param name="input_type" value="collection"/>
201984e0cab2 Uploaded
greg
parents:
diff changeset
30 <param name="input_vcf_collection">
201984e0cab2 Uploaded
greg
parents:
diff changeset
31 <collection type="list">
201984e0cab2 Uploaded
greg
parents:
diff changeset
32 <element name="input1" value="input1.vcf" ftype="vcf"/>
201984e0cab2 Uploaded
greg
parents:
diff changeset
33 <element name="input2" value="input2.vcf" ftype="vcf"/>
201984e0cab2 Uploaded
greg
parents:
diff changeset
34 <element name="input3" value="input3.vcf" ftype="vcf"/>
201984e0cab2 Uploaded
greg
parents:
diff changeset
35 <element name="input4" value="input4.vcf" ftype="vcf"/>
201984e0cab2 Uploaded
greg
parents:
diff changeset
36 </collection>
201984e0cab2 Uploaded
greg
parents:
diff changeset
37 </param>
201984e0cab2 Uploaded
greg
parents:
diff changeset
38 <output name="output" value="output.tabular"/>
201984e0cab2 Uploaded
greg
parents:
diff changeset
39 </test>
201984e0cab2 Uploaded
greg
parents:
diff changeset
40 </tests>
201984e0cab2 Uploaded
greg
parents:
diff changeset
41 <help><![CDATA[
201984e0cab2 Uploaded
greg
parents:
diff changeset
42 **What it does**
201984e0cab2 Uploaded
greg
parents:
diff changeset
43
201984e0cab2 Uploaded
greg
parents:
diff changeset
44 Combine the SNP positions across all samples into a single unified SNP list
201984e0cab2 Uploaded
greg
parents:
diff changeset
45 file identifing the positions and sample names where SNPs were called.
201984e0cab2 Uploaded
greg
parents:
diff changeset
46
201984e0cab2 Uploaded
greg
parents:
diff changeset
47 **Optional parameters**
201984e0cab2 Uploaded
greg
parents:
diff changeset
48
201984e0cab2 Uploaded
greg
parents:
diff changeset
49 * **force** - Force processing even when result file already exists and is newer than inputs (default: False)
201984e0cab2 Uploaded
greg
parents:
diff changeset
50 * **vcfname** - File name of the VCF files which must exist in each of the sample directories (default: var.flt.vcf)
201984e0cab2 Uploaded
greg
parents:
diff changeset
51 * **maxsnps** - Exclude samples having more than this maximum allowed number of SNPs. Set to -1 to disable this function (default: -1)
201984e0cab2 Uploaded
greg
parents:
diff changeset
52
201984e0cab2 Uploaded
greg
parents:
diff changeset
53 **More information**
201984e0cab2 Uploaded
greg
parents:
diff changeset
54
201984e0cab2 Uploaded
greg
parents:
diff changeset
55 CFSAN SNP Pipeline `merge sites documentation <https://snp-pipeline.readthedocs.io/en/latest/cmd_ref.html#merge-sites>`_
201984e0cab2 Uploaded
greg
parents:
diff changeset
56 ]]></help>
201984e0cab2 Uploaded
greg
parents:
diff changeset
57 <expand macro="citations"/>
201984e0cab2 Uploaded
greg
parents:
diff changeset
58 </tool>
201984e0cab2 Uploaded
greg
parents:
diff changeset
59