annotate masking.xml @ 0:fae6527990af draft

Imported from capsule None
author iuc
date Thu, 21 May 2015 03:58:09 -0400
parents
children f29e21388219
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
1 <tool id="vsearch_masking" name="VSearch masking" version="@VERSION@.0">
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
2 <description></description>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
3 <macros>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
4 <import>vsearch_macros.xml</import>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
5 </macros>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
6 <expand macro="requirements" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
7 <expand macro="stdio" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
8 <expand macro="version_command" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
9 <command>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
10 <![CDATA[
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
11 vsearch
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
12 @GENERAL@
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
13 #if $qmask != 'no':
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
14 --qmask $qmask
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
15 #end if
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
16 $hardmask
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
17 --maskfasta "$infile"
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
18 --output $outfile
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
19
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
20 ]]>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
21 </command>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
22 <inputs>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
23 <param name="infile" type="data" format="fasta" label="Select your FASTA file" help="(--maskfasta)" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
24 <expand macro="qmask" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
25 <expand macro="hardmask" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
26 </inputs>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
27 <outputs>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
28 <data name="outfile" format="fasta" label="${tool.name} on ${on_string}" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
29 </outputs>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
30 <tests>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
31 <test>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
32 <param name="infile" value="db.fasta" ftype="fasta" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
33 <param name="qmask" value="dust"/>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
34 <param name="hardmask" value="True"/>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
35 <output name="outfile" file="masking_result1.fasta" ftype="fasta" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
36 </test>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
37 <test>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
38 <param name="infile" value="db.fasta" ftype="fasta" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
39 <param name="qmask" value="soft"/>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
40 <param name="hardmask" value="True"/>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
41 <output name="outfile" file="masking_result2.fasta" ftype="fasta" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
42 </test>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
43 </tests>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
44 <help>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
45 <![CDATA[
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
46 **What it does**
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
47
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
48 An input sequence can be composed of lower- or uppercase nucleotides. Lowercase nucleotides
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
49 are silently set to uppercase before masking, unless the −−qmask soft option is used.
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
50 Here are the results of combined masking options −−qmask (or −−dbmask for database sequences) and −−hardmask, assuming each input sequences contains both lower and uppercase nucleotides:
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
51
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
52 ===== ======== ================================================
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
53 qmask hardmask action
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
54 ===== ======== ================================================
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
55 none off no masking, all symbols uppercased
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
56 none on no masking, all symbols uppercased
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
57 dust off masked symbols lowercased, others uppercased
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
58 dust on masked symbols changed to Ns, others uppercased
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
59 soft off lowercase symbols masked, no case changes
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
60 soft on lowercase symbols masked and changed to Ns
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
61 ===== ======== ================================================
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
62
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
63 Masking options
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
64 --hardmask mask by replacing with N instead of lower case
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
65 --maskfasta FILENAME mask sequences in the given FASTA file
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
66 --output FILENAME output to specified FASTA file
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
67 --qmask mask seqs with "dust", "soft" or "none" method (dust)
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
68
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
69 @EXTERNAL_DOCUMENTATION@
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
70
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
71 -------
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
72
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
73 @REFERENCES@
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
74
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
75
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
76 ]]>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
77 </help>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
78 <expand macro="citations" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
79 </tool>