annotate sorting.xml @ 0:fae6527990af draft

Imported from capsule None
author iuc
date Thu, 21 May 2015 03:58:09 -0400
parents
children 8c4e2933a17a
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_sorting" name="VSearch sorting" 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 $sorting_mode.sorting_mode_select == 'sortbylength':
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
14 --sortbylength "$sorting_mode.infile"
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
15 #else:
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
16 --sortbysize "$sorting_mode.infile"
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
17 #if $sorting_mode.minsize:
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
18 --minsize $sorting_mode.minsize
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
19 #end if
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
20 #if $sorting_mode.maxsize:
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
21 --maxsize $sorting_mode.maxsize
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
22 #end if
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
23 #end if
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
24 --output $outfile
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
25 #if $sizeout:
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
26 --sizeout $sizeout
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
27 #end if
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
28 #if $topn:
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
29 --topn $topn
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
30 #end if
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
31
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
32 ]]>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
33 </command>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
34 <inputs>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
35 <conditional name="sorting_mode">
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
36 <param name="sorting_mode_select" type="select" label="Sorting by" help="">
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
37 <option value="sortbylength">sequence length</option>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
38 <option value="sortbyabundance">by abundance</option>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
39 </param>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
40 <when value="sortbylength">
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
41 <param name="infile" type="data" format="fasta" label="Select your FASTA file" help="(--sortbylength)" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
42 </when>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
43 <when value="sortbyabundance">
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
44 <param name="infile" type="data" format="fasta" label="Select your FASTA file" help="(--sortbysize)" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
45 <param name="minsize" type="integer" value="" optional="True" label="Minimum abundance"
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
46 help="(--minsize)"/>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
47 <param name="maxsize" type="integer" value="" optional="True" label="Maximum abundance"
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
48 help="(--maxsize)"/>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
49 </when>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
50 </conditional>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
51 <expand macro="topn" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
52 <param name="sizeout" type="boolean" truevalue="--sizeout" falsevalue="" checked="False"
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
53 label="Add abundance annotation to output" help="(--sizeout)"/>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
54 </inputs>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
55 <outputs>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
56 <data name="outfile" format="fasta" label="${tool.name} on ${on_string}" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
57 </outputs>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
58 <tests>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
59 <test>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
60 <param name="sorting_mode_select" value="sortbyabundance"/>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
61 <param name="infile" value="db.fasta" ftype="fasta" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
62 <output name="outfile" file="sorting_result1.fasta" ftype="fasta" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
63 </test>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
64 <test>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
65 <param name="sorting_mode_select" value="sortbylength"/>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
66 <param name="infile" value="db.fasta" ftype="fasta" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
67 <output name="outfile" file="sorting_result2.fasta" ftype="fasta" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
68 </test>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
69 </tests>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
70 <help>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
71 <![CDATA[
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
72 **What it does**
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
73
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
74 Fasta entries are sorted by decreasing abundance (−−sortbysize) or sequence length (−−sort-
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
75 bylength). To obtain a stable sorting order, ties are sorted by decreasing abundance and label
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
76 increasing alpha-numerical order (−−sortbylength), or just by label increasing alpha-numerical
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
77 order (−−sortbysize). Label sorting assumes that all sequences have unique labels. The same
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
78 applies to the automatic sorting performed during chimera checking (−−uchime_denovo), derepli-
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
79 cation (−−derep_fulllength), and clustering (−−cluster_fast and −−cluster_size).
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
80
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
81 Sorting options
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
82 --maxsize INT maximum abundance for sortbysize
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
83 --minsize INT minimum abundance for sortbysize
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
84 --output FILENAME output FASTA file
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
85 --relabel STRING relabel with this prefix string after sorting
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
86 --sizeout add abundance annotation to output
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
87 --sortbylength FILENAME sort sequences by length in given FASTA file
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
88 --sortbysize FILENAME abundance sort sequences in given FASTA file
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
89 --topn INT output just top n seqs after sorting
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
90
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
91
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
92 @EXTERNAL_DOCUMENTATION@
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
93
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
94 -------
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
95
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
96 @REFERENCES@
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
97
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
98
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
99 ]]>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
100 </help>
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
101 <expand macro="citations" />
fae6527990af Imported from capsule None
iuc
parents:
diff changeset
102 </tool>