Mercurial > repos > iuc > mothur_filter_shared

comparison filter.shared.xml @ 3:d3f5d41208c1 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
author iuc
date Wed, 14 Feb 2018 10:02:54 -0500
parents 897ba33ecbdb
children b82c30e359e0
comparison
equal deleted inserted replaced
2:5ac62cae5e9c 3:d3f5d41208c1
5 </macros> 5 </macros>
6 <expand macro="requirements"/> 6 <expand macro="requirements"/>
7 <expand macro="stdio"/> 7 <expand macro="stdio"/>
8 <expand macro="version_command"/> 8 <expand macro="version_command"/>
9 <command><![CDATA[ 9 <command><![CDATA[
10 @SHELL_OPTIONS@ 10 @SHELL_OPTIONS@
11 11
12 ## create symlinks to input datasets 12 ## create symlinks to input datasets
13 ln -s "$otu" otu.dat && 13 ln -s '$otu' otu.dat &&
14 14
15 echo 'filter.shared( 15 echo 'filter.shared(
16 shared=otu.dat, 16 shared=otu.dat,
17 #if $label: 17 #if $label:
18 label=${ str($label).replace(",","-") }, 18 label=${ str($label).replace(",","-") },
19 #end if 19 #end if
20 #if $label: 20 #if $label:
21 groups=${ str($groups).replace(",","-") }, 21 groups=${ str($groups).replace(",","-") },
22 #end if 22 #end if
23 minabund=$minabund, 23 minabund=$minabund,
24 minpercent=$minpercent, 24 minpercent=$minpercent,
25 rarepercent=$rarepercent, 25 rarepercent=$rarepercent,
26 keepties=$keepties, 26 keepties=$keepties,
27 minnumsamples=$minnumsamples, 27 minnumsamples=$minnumsamples,
28 minpercentsamples=$minpercentsamples, 28 minpercentsamples=$minpercentsamples,
29 mintotal=$mintotal, 29 mintotal=$mintotal,
30 makerare=$makerare 30 makerare=$makerare
31 )' 31 )'
32 | sed 's/ //g' ## mothur trips over whitespace 32 | sed 's/ //g' ## mothur trips over whitespace
33 | mothur 33 | mothur
34 | tee mothur.out.log 34 | tee mothur.out.log
35 ]]></command> 35 ]]></command>
36 <inputs> 36 <inputs>
37 <param name="otu" type="data" format="mothur.shared" label="shared - specify your shared file"/> 37 <param name="otu" argument="shared" type="data" format="mothur.shared" label="shared - specify your shared file"/>
38 <param name="label" type="select" optional="true" multiple="true" label="label - OTU Labels" help="If none selected, all labels will be output"> 38 <param argument="label" type="select" optional="true" multiple="true" label="label - OTU Labels" help="If none selected, all labels will be output">
39 <expand macro="labeloptions"/> 39 <expand macro="labeloptions"/>
40 </param> 40 </param>
41 <param name="groups" type="select" optional="true" multiple="true" label="Select groups for to include in this grouping"> 41 <param argument="groups" type="select" optional="true" multiple="true" label="Select groups for to include in this grouping">
42 <options> 42 <options>
43 <filter type="data_meta" ref="otu" key="groups"/> 43 <filter type="data_meta" ref="otu" key="groups"/>
44 </options> 44 </options>
45 </param> 45 </param>
46 <param name="minabund" type="integer" value="0" min="0" label="minabund - indicate the minimum abundance required for each sample in a given OTU" help="If any samples abundance falls below the minimum, the OTU is removed. Default=0"/> 46 <param argument="minabund" type="integer" value="0" min="0" label="minabund - indicate the minimum abundance required for each sample in a given OTU"
47 <param name="minpercent" type="integer" value="0" min="0" max="100" label="minpercent - indicate the minimum relative abundance of an OTU" help="For example, if the OTUs total abundance across all samples is 8, and the total abundance across all OTUs is 1000, and minpercent=1. The OTU's relative abundance is 0.008, the minimum is 0.01, so the OTU will be removed (Default=0)"/> 47 help="If any samples abundance falls below the minimum, the OTU is removed"/>
48 <param name="rarepercent" type="integer" value="0" min="0" max="100" label="rarepercent - indicate the percentage of otus to remove" help="The OTUs chosen to be removed are the rarest. For example if you have 1000 OTUs, rarepercent=20 would remove the 200 OTUs with the lowest abundance (Default=0)"/> 48 <param argument="minpercent" type="integer" value="0" min="0" max="100" label="minpercent - indicate the minimum relative abundance of an OTU"
49 <param name="keepties" type="boolean" truevalue="true" falsevalue="false" checked="true" label="keepties - indicate you want to keep the OTUs with the same abundance as the first 'not rare' OTU" help="For example if you have 10 OTUs, rarepercent=20 abundances of 20, 18, 15, 15, 10, 5, 3, 3, 3, 1. keepties=t, would remove the 10th OTU, but keep the 9th because its abundance ties the 8th OTU. keepties=f would remove OTUs 9 and 10 (Default=T)"/> 49 help="For example, if the OTUs total abundance across all samples is 8, and the total abundance across all OTUs is 1000, and minpercent=1.
50 <param name="minnumsamples" type="integer" value="0" min="0" label="minnumsamples - indicate the minimum number of samples present in an OTU" help="If the number of samples present falls below the minimum, the OTU is removed (Default=0)"/> 50 The OTU's relative abundance is 0.008, the minimum is 0.01, so the OTU will be removed"/>
51 <param name="minpercentsamples" type="integer" value="0" min="0" max="100" label="minpercentsamples - indicate the minimum percent of sample present in an OTU" help="For example, if the total number of samples is 10, the number present is 3, and the minpercentsamples=50. The OTU's precent of samples is 0.333, the minimum is 0.50, so the OTU will be removed (Default=0)"/> 51 <param argument="rarepercent" type="integer" value="0" min="0" max="100" label="rarepercent - indicate the percentage of otus to remove"
52 <param name="mintotal" type="integer" value="0" min="0" max="100" label="mintotal - indicate the minimum abundance required for a given OTU" help="If abundance across all samples falls below the minimum, the OTU is removed (Default=0)"/> 52 help="The OTUs chosen to be removed are the rarest. For example if you have 1000 OTUs, rarepercent=20 would remove the 200 OTUs with the lowest abundance"/>
53 <param name="makerare" type="boolean" truevalue="true" falsevalue="false" checked="true" label="makerare - indicate you want the abundances of any removed OTUs to be saved and a new rare OTU created with its abundances equal to the sum of the OTUs removed" help="This will preserve the number of reads in your dataset (Default=T)"/> 53 <param argument="keepties" type="boolean" truevalue="true" falsevalue="false" checked="true"
54 label="keepties - indicate you want to keep the OTUs with the same abundance as the first 'not rare' OTU"
55 help="For example if you have 10 OTUs, rarepercent=20 abundances of 20, 18, 15, 15, 10, 5, 3, 3, 3, 1. keepties=t, would remove the 10th OTU,
56 but keep the 9th because its abundance ties the 8th OTU. keepties=f would remove OTUs 9 and 10"/>
57 <param argument="minnumsamples" type="integer" value="0" min="0" label="minnumsamples - indicate the minimum number of samples present in an OTU"
58 help="If the number of samples present falls below the minimum, the OTU is removed"/>
59 <param argument="minpercentsamples" type="integer" value="0" min="0" max="100" label="minpercentsamples - indicate the minimum percent of sample present in an OTU"
60 help="For example, if the total number of samples is 10, the number present is 3, and the minpercentsamples=50. The OTU's precent of samples is 0.333,
61 the minimum is 0.50, so the OTU will be removed (Default=0)"/>
62 <param argument="mintotal" type="integer" value="0" min="0" max="100" label="mintotal - indicate the minimum abundance required for a given OTU"
63 help="If abundance across all samples falls below the minimum, the OTU is removed"/>
64 <param argument="makerare" type="boolean" truevalue="true" falsevalue="false" checked="true"
65 label="makerare - indicate you want the abundances of any removed OTUs to be saved and a new rare OTU created with its abundances equal to the sum of the OTUs removed"
66 help="This will preserve the number of reads in your dataset"/>
54 </inputs> 67 </inputs>
55 <outputs> 68 <outputs>
56 <expand macro="logfile-output"/> 69 <expand macro="logfile-output"/>
57 <collection name="filter_shared" type="list" label="${tool.name} on ${on_string}: filter.shared"> 70 <collection name="filter_shared" type="list" label="${tool.name} on ${on_string}: filter.shared">
58 <discover_datasets pattern=".*?\.(?P&lt;designation&gt;.*)\.filter\.dat" format="mothur.shared"/> 71 <discover_datasets pattern=".*?\.(?P&lt;designation&gt;.*)\.filter\.dat" format="mothur.shared"/>
59 </collection> 72 </collection>
60 </outputs> 73 </outputs>
61 <tests> 74 <tests>
62 <test><!-- test with defaults --> 75 <test><!-- test with defaults -->
63 <param name="otu" value="amazon.an.shared" ftype="mothur.shared"/> 76 <param name="otu" value="esophagus.fn.shared" ftype="mothur.shared"/>
64 <param name="minabund" value="1"/> 77 <output_collection name="filter_shared" count="4">
65 <output_collection name="filter_shared" count="36"> 78 <element name="0.03" ftype="mothur.shared">
66 <element name="0.29" md5="db8387475c126110f2ac21066344c933" ftype="mothur.shared"/> 79 <assert_contents>
80 <expand macro="test-shared-format"/>
81 <has_text text="0.03"/>
82 </assert_contents>
83 </element>
67 </output_collection> 84 </output_collection>
68 <expand macro="logfile-test"/> 85 <expand macro="logfile-test"/>
69 </test> 86 </test>
70 <test><!-- test with label and group select --> 87 <test><!-- test with label and group select -->
71 <param name="otu" value="amazon.an.shared" ftype="mothur.shared"/> 88 <param name="otu" value="amazon.an.shared" ftype="mothur.shared"/>
72 <param name="label" value="0.05,0.29,0.33"/> 89 <param name="label" value="0.05,0.29,0.33"/>
73 <param name="groups" value="forest,pasture"/> 90 <param name="groups" value="forest,pasture"/>
74 <param name="minabund" value="1"/> 91 <param name="minabund" value="1"/>
75 <output_collection name="filter_shared" count="3"> 92 <output_collection name="filter_shared" count="3">
76 <element name="0.29" md5="db8387475c126110f2ac21066344c933" ftype="mothur.shared"/> 93 <element name="0.29" ftype="mothur.shared">
94 <assert_contents>
95 <expand macro="test-shared-format"/>
96 <has_text text="0.29"/>
97 </assert_contents>
98 </element>
77 </output_collection> 99 </output_collection>
78 <expand macro="logfile-test"/> 100 <expand macro="logfile-test"/>
79 </test> 101 </test>
80 </tests> 102 </tests>
81 <help> 103 <help><![CDATA[
82 <![CDATA[
83 104
84 @MOTHUR_OVERVIEW@ 105 @MOTHUR_OVERVIEW@
85 106
86 **Command Documentation** 107 **Command Documentation**
87 108
88 The filter.shared_ is used to remove OTUs based on various critieria. 109 The filter.shared_ is used to remove OTUs based on various critieria.
89 110
90 .. _filter.shared: https://www.mothur.org/wiki/Filter.shared 111 .. _filter.shared: https://www.mothur.org/wiki/Filter.shared
91 112
92 ]]> 113 ]]></help>
93 </help>
94 <citations> 114 <citations>
95 <citation type="doi">10.1128/AEM.01541-09</citation> 115 <citation type="doi">10.1128/AEM.01541-09</citation>
96 </citations> 116 </citations>
97 </tool> 117 </tool>