annotate snippy_clean_full_aln.xml @ 13:d220115f882b draft default tip

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 4a4272101587c70abd11779660e77bc8718688e2"
author iuc
date Sat, 10 Jul 2021 07:46:31 +0000
parents fa016f1eea1a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
1 <?xml version="1.0" encoding="utf-8"?>
12
fa016f1eea1a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 7dec701af24e00b3328459f0a823eefd461237bb"
iuc
parents: 11
diff changeset
2 <tool id="snippy_clean_full_aln" name="snippy-clean_full_aln" version="@WRAPPER_VERSION@+galaxy@VERSION_SUFFIX@">
10
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
3 <description>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
4 Replace any non-standard sequence characters in snippy 'core.full.aln' file.
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
5 </description>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
6 <macros>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
7 <import>macros.xml</import>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
8 </macros>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
9 <expand macro="requirements" />
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
11 snippy-clean_full_aln
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
12 '${full_aln}'
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
13 #if $custom_char.custom_char_selector:
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
14 --to '${custom_char.to_char}'
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
15 #end if
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
16 > '${clean_full_aln}'
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
17 ]]></command>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
18
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
19 <inputs>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
20 <param name="full_aln" type="data" format="fasta" label="Snippy core.full.aln file" help="" />
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
21 <conditional name="custom_char">
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
22 <param name="custom_char_selector" type="boolean" display="radio" label="Use custom replacement character" />
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
23 <when value="false" />
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
24 <when value="true">
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
25 <param name="to_char" type="text" label="Replacement character" help="Replace non-[AGTCN-] chars with this character, defaults to 'N' if none entered" >
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
26 <sanitizer>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
27 <valid initial="string.printable">
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
28 <remove value="&apos;" />
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
29 </valid>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
30 <mapping initial="none">
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
31 <add source="&apos;" target="&apos;&quot;&apos;&quot;&apos;" />
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
32 </mapping>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
33 </sanitizer>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
34 </param>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
35 </when>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
36 </conditional>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
37 </inputs>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
38 <outputs>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
39 <data name="clean_full_aln" format="fasta" label="${tool.name} on ${on_string} cleaned core alignment" />
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
40 </outputs>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
41 <tests>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
42 <test>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
43 <param name="full_aln" value="core.full.nonclean.aln" />
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
44 <output name="clean_full_aln">
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
45 <assert_contents>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
46 <has_line line="GCNNCG" />
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
47 </assert_contents>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
48 </output>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
49 </test>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
50 <test>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
51 <param name="full_aln" value="core.full.nonclean.aln" />
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
52 <param name="custom_char_selector" value="true" />
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
53 <param name="to_char" value="X" />
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
54 <output name="clean_full_aln">
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
55 <assert_contents>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
56 <has_line line="GCXXCG" />
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
57 </assert_contents>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
58 </output>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
59 </test>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
60 </tests>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
61 <help><![CDATA[
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
62 The core.full.aln file is a FASTA formatted multiple sequence alignment file.
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
63 It has one sequence for the reference, and one for each sample participating
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
64 in the core genome calculation. Each sequence has the same length as the reference
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
65 sequence.
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
66
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
67 Character Meaning
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
68 ATGC Same as the reference
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
69 atgc Different from the reference
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
70 - Zero coverage in this sample or a deletion relative to the reference
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
71 N Low coverage in this sample (based on --mincov)
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
72 X Masked region of reference (from --mask)
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
73 n Heterozygous or poor quality genotype (has GT=0/1 or QUAL < --minqual in snps.raw.vcf)
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
74
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
75 You can remove all the "weird" characters and replace them with N using this tool.
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
76 This is useful when you need to pass it to a tree-building or recombination-removal
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
77 tool:
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
78
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
79 ```
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
80 % snippy-clean_full_aln core.full.aln > clean.full.aln
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
81 % run_gubbins.py -p gubbins clean.full.aln
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
82 % snp-sites -c gubbins.filtered_polymorphic_sites.fasta > clean.core.aln
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
83 % FastTree -gtr -nt clean.core.aln > clean.core.tree
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
84 ```
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
85 ]]></help>
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
86 <expand macro="citations" />
3fe8ef358d66 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/snippy commit 25b2375521fec3162644696b67e54f654fab2e79"
iuc
parents:
diff changeset
87 </tool>