annotate cooccurrence.xml @ 3:1bebb226e793 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
author iuc
date Wed, 14 Feb 2018 09:16:00 -0500
parents 72f9b9aca28d
children 7947bd3c6e8a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
1 <tool profile="16.07" id="mothur_cooccurrence" name="Cooccurrence" version="@WRAPPER_VERSION@.0">
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
2 <description>tests whether presence-absence patterns differ from chance</description>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
3 <macros>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
4 <import>macros.xml</import>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
5 </macros>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
6 <expand macro="requirements"/>
1
72f9b9aca28d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit ea40e3d84e7850eb4226d6c85f709dcad18d4ba9
iuc
parents: 0
diff changeset
7 <expand macro="stdio"/>
0
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
8 <expand macro="version_command"/>
1
72f9b9aca28d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit ea40e3d84e7850eb4226d6c85f709dcad18d4ba9
iuc
parents: 0
diff changeset
9 <command><![CDATA[
3
1bebb226e793 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
iuc
parents: 1
diff changeset
10 @SHELL_OPTIONS@
1
72f9b9aca28d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit ea40e3d84e7850eb4226d6c85f709dcad18d4ba9
iuc
parents: 0
diff changeset
11
3
1bebb226e793 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
iuc
parents: 1
diff changeset
12 ## create symlinks to input datasets
1bebb226e793 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
iuc
parents: 1
diff changeset
13 ln -s '$otu' otu.dat &&
0
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
14
3
1bebb226e793 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
iuc
parents: 1
diff changeset
15 echo 'cooccurrence(
1bebb226e793 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
iuc
parents: 1
diff changeset
16 shared=otu.dat,
1bebb226e793 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
iuc
parents: 1
diff changeset
17 metric=$metric,
1bebb226e793 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
iuc
parents: 1
diff changeset
18 matrixmodel=$matrixmodel,
1bebb226e793 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
iuc
parents: 1
diff changeset
19 iters=$iters
1bebb226e793 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
iuc
parents: 1
diff changeset
20 #if $label:
1bebb226e793 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
iuc
parents: 1
diff changeset
21 ,label=${ str($label).replace(",","-") }
1bebb226e793 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
iuc
parents: 1
diff changeset
22 #end if
1bebb226e793 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
iuc
parents: 1
diff changeset
23 #if $groups:
1bebb226e793 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
iuc
parents: 1
diff changeset
24 ,groups=${ str($groups).replace(",","-") }
1bebb226e793 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
iuc
parents: 1
diff changeset
25 #end if
1bebb226e793 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
iuc
parents: 1
diff changeset
26 )'
1bebb226e793 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
iuc
parents: 1
diff changeset
27 | sed 's/ //g' ## mothur trips over whitespace
1bebb226e793 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
iuc
parents: 1
diff changeset
28 | mothur
1bebb226e793 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
iuc
parents: 1
diff changeset
29 | tee mothur.out.log
0
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
30 ]]></command>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
31 <inputs>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
32 <param name="otu" type="data" format="mothur.shared" label="shared - OTU Shared file"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
33 <param name="iters" type="integer" value="1000" min="1" optional="true" label="iters - Number of iterations to try (default 1000)"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
34 <param name="metric" type="select" label="metric - test metric for scoring">
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
35 <option value="cscore" selected="true">cscore - species segregation</option>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
36 <option value="checker">checker - species segregation</option>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
37 <option value="combo">combo - unique species pairs</option>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
38 <option value="vratio">vratio - variance</option>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
39 </param>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
40 <param name="matrixmodel" type="select" label="matrixmodel - the scoring matrix" help="See the notes below on choosing a metric/matrixmodel combination">
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
41 <option value="sim1">sim1</option>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
42 <option value="sim2" selected="true">sim2</option>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
43 <option value="sim3">sim3</option>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
44 <option value="sim4">sim4</option>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
45 <option value="sim5">sim5</option>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
46 <option value="sim6">sim6</option>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
47 <option value="sim7">sim7</option>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
48 <option value="sim8">sim8</option>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
49 <option value="sim9">sim9</option>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
50 </param>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
51 <param name="groups" type="select" optional="true" label="groups - Groups to include" multiple="true" help="By default all are included if no selection is made.">
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
52 <options>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
53 <filter type="data_meta" ref="otu" key="groups"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
54 </options>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
55 </param>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
56 <param name="label" type="select" optional="true" label="label - Select OTU Labels to include" multiple="true" help="By default all are included if no selection is made.">
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
57 <expand macro="labeloptions"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
58 </param>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
59 </inputs>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
60 <outputs>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
61 <expand macro="logfile-output"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
62 <data name="out_summary" format="tabular" from_work_dir="otu*.summary" label="${tool.name} on ${on_string}: cooccurence.summary"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
63 </outputs>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
64 <tests>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
65 <test><!-- test with defaults -->
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
66 <param name="otu" value="amazon.an.shared" ftype="mothur.shared"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
67 <output name="out_summary" ftype="tabular">
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
68 <assert_contents>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
69 <has_text text="zScore"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
70 <has_text text="cscore"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
71 <has_text text="unique"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
72 <has_text text="0.05"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
73 </assert_contents>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
74 </output>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
75 <expand macro="logfile-test"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
76 </test>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
77 <test><!-- test with label and group select -->
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
78 <param name="otu" value="amazon.an.shared" ftype="mothur.shared"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
79 <param name="metric" value="vratio"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
80 <param name="label" value="0.05,0.22,0.41"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
81 <param name="groups" value="forest,pasture"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
82 <output name="out_summary" ftype="tabular">
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
83 <assert_contents>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
84 <has_text text="zScore"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
85 <has_text text="vratio"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
86 <not_has_text text="unique"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
87 <has_text text="0.05"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
88 </assert_contents>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
89 </output>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
90 <expand macro="logfile-test"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
91 </test>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
92 </tests>
3
1bebb226e793 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
iuc
parents: 1
diff changeset
93 <help><![CDATA[
0
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
94
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
95 @MOTHUR_OVERVIEW@
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
96
1
72f9b9aca28d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit ea40e3d84e7850eb4226d6c85f709dcad18d4ba9
iuc
parents: 0
diff changeset
97 **Command Documentation**
0
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
98
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
99 The cooccurrence_ command variance calculates four metrics and tests their significance to assess whether presence-absence patterns are different than what one would expect by chance. The input is a shared_ file. The output can be filtered by groups and labels.
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
100
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
101
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
102
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
103 **metric**
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
104
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
105 The metric parameter options are **cscore**, **checker**, **combo** and **vratio**. Default=cscore. The cscore or checkerboard score [1] is a metric that measures species segregation. It is the mean number of checkerboard units per species pair. The checker metric [2] counts the number of species pairs forming a perfect checkerboard. The combo metric [3] is the number of unique species pairs. The vratio or variance ratio [4] is a measure of the species association calculated by the ratio of the variance in total species number to the sum of the variances of the species. ::
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
106
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
107 [1] Stone, L., and A. Roberts. 1990. The checkerboard score and species distributions. Ocelogia. 85:74-79.
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
108 [2] Diamond, J. M. 1975. Assembly of species communities. Pages 342-444 in M. L. Cody and J. M. Diamond, editors. Ecology and evolution of communities. Harvard University Press, Cambridge, Massachusetts, USA.
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
109 [3] Pielou, D. P., and E. C. Pielou. 1968 Association among species of infrequent occurrence: the insect and spider fauna of Polypours betulinus (Bulliard) Fries. Journal of Theoretical Biology 21:202-216.
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
110 [4] Schluter, D. 1984. A variance test for detecting species associations, with some example applications. Ecology 65:998-1005.
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
111 [5] Gotelli, Nicholas J. 2000. NULL MODEL ANALYSIS OF SPECIES CO-OCCURRENCE PATTERNS. Ecology 81:2606-2621.
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
112
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
113
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
114
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
115 **matrixmodel**
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
116
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
117 The matrixmodel parameter allows you to select the model you would like to use. Options are sim1, sim2, sim3, sim4, sim5, sim6, sim7, sim8 and sim9. Default=sim2.
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
118
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
119 Each sim implements a different algorithm for generating null matrices with constraints on the rows (species) and columns (sites).::
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
120 ===================== ====================== ======================= ======================
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
121 Rows Columns equiprobable Columns proportional Column totals fixed
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
122 ===================== ====================== ======================= ======================
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
123 Rows equiprobable sim1 sim6 sim3
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
124 Rows proportional sim7 sim8 sim5
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
125 Row totals fixed sim2 sim4 sim9
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
126 ===================== ====================== ======================= ======================
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
127
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
128 Equiprobable rows or columns means that each row, column or both is not dependent on the original co-occurrence matrix. Each species or site has an equal change of occurring in the null matrix.
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
129 Proportional rows or columns means that the proportion of occurrences in rows, columns or both in the original co-occurrence matrix are preserved but the totals may differ. Each species or site's chances of occurring are proportional to their occurrence in the original co-occurrence matrix.
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
130 Fixed row or column totals preserves the total number of occurrences in rows, columns or both in the original co-occurrence matrix. Sim9 is a special case that is not probabilistic. Since both the row and column totals are preserved the only way to randomize the matrix is with a checkerboard swap. When a checkerboard appears in the matrix the 1s and 0s are swapped to their mirror image to preserve the species and site totals.
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
131
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
132 Checkerboard::
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
133
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
134 10
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
135 01
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
136
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
137 Swap::
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
138
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
139 01
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
140 10
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
141
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
142
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
143 suggested metric/matrixmodel combinations::
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
144 ======== ======== ======== ========
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
145 cscore checker combo vratio
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
146 ======== ======== ======== ========
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
147 sim9 sim9 sim9 sim2
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
148 sim2 sim2 sim2 sim4
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
149 - - sim4 sim8
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
150 - - sim8 -
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
151 ======== ======== ======== ========
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
152
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
153
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
154 Careful readers will note that none of the suggested matrixmodels have equiprobable rows (species). This is because tests of co-occurrence are quite sensitive to the frequency of species occurrence. As such, rowtotals should be maintained or at least kept proportional in the null models. Sim9 is well suited to co-occurrence matrices that have an "island list" structure. Island lists are often found in classical ecology datasets that contain species with well defined habitat patches and are rarely degenerate (matrices that contain empty rows or columns). Sim2 is well suited for co-occurrence matrices that have a "sample list" structure. Sample list structured data are found where species have relatively homogeneous habitats and degenerate matrices are not uncommon. In these matrices species will often occur in only one site.
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
155 The default values of cscore and sim2 have been selected because the c-score is not very sensitive to noise in the data and when used with sim9 or sim2 is not particularly prone to false positives. Sim2 has been chosen because of the prevalence of degenerate matrices. These are just guidelines, however, be sure to select a metric and matrix model that is best suited to the type of data you are analyzing.
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
156 It should be noted that sim9 cannot be used with vratio because in sim9 both the column and row totals are maintained, hence there will be no variance.
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
157 Please see [5] for more details on metric/null model selection.
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
158
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
159
1
72f9b9aca28d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit ea40e3d84e7850eb4226d6c85f709dcad18d4ba9
iuc
parents: 0
diff changeset
160 .. _shared: https://www.mothur.org/wiki/Shared_file
72f9b9aca28d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit ea40e3d84e7850eb4226d6c85f709dcad18d4ba9
iuc
parents: 0
diff changeset
161 .. _cooccurrence: https://www.mothur.org/wiki/Cooccurrence
0
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
162
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
163 v1.26.0: Updated to Mothur 1.33
3
1bebb226e793 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
iuc
parents: 1
diff changeset
164
1bebb226e793 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 4648c7574a78601e03ae6a318cbcd5b492a8a9f4
iuc
parents: 1
diff changeset
165 ]]></help>
0
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
166 <expand macro="citations"/>
e1330cc9b7e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit 180a403421967d36f995941b1a4561349d75cfc5
iuc
parents:
diff changeset
167 </tool>