Mercurial > repos > devteam > vegan_rarefaction

comparison vegan_rarefaction.xml @ 0:cc2380c0cf10 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-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
author devteam
date Mon, 24 Aug 2015 10:55:33 -0400
parents
children da3fbdaaec5b
comparison
equal deleted inserted replaced
-1:000000000000 0:cc2380c0cf10
1 <tool id="vegan_rarefaction" name="Vegan Rarefaction" version="0.0.1">
2 <description>
3 curve and statistics
4 </description>
5 <requirements>
6 <requirement type="package" version="3.2.1">R</requirement>
7 <requirement type="package" version="2.3-0">vegan</requirement>
8 </requirements>
9 <stdio>
10 <exit_code range="1:" />
11 <exit_code range=":-1" />
12 </stdio>
13
14 <command><![CDATA[
15 #if "output_r_script" in str( $include_outputs ).split( "," ):
16 cp "${vegan_rarefaction_script}" "${output_r_script}" &&
17 #end if
18 Rscript "${vegan_rarefaction_script}"
19 ]]>
20 </command>
21 <configfiles>
22 <configfile name="vegan_rarefaction_script"><![CDATA[
23 #set $include_files = str( $include_outputs ).split( "," )
24 #set $int_species_column = int( str( $species_column ) )
25 #set $fixed_sample_columns = []
26 #for $sample_col in map( int, str( $sample_columns ).split( "," ) ):
27 #assert $sample_col != $int_species_column, "Sample label column and sample count columns must not be the same."
28 #silent $fixed_sample_columns.append( str( $sample_col if $sample_col < $int_species_column else $sample_col-1 ) )
29 #end for
30 options(bitmapType='cairo')## No X11, so we'll use cairo
31 library(vegan)
32 input_abundance <- read.table("${input_abundance}", sep="\t", row.names=${ species_column }, header=FALSE )
33
34 input_abundance <- t( input_abundance[ c( ${ ",".join( $fixed_sample_columns ) } )] )
35
36 #if str( $sample_size ) == '':
37 raremax <- min(rowSums(input_abundance))
38 raremax_offset <- -1
39 sprintf("Automatically determining subsampling size, will apply offset to slope calculation and species probabilities.")
40 #else:
41 raremax = $sample_size
42 raremax_offset <- 0
43 #end if
44 sprintf("Using sample size: %i", raremax)
45 Srare <- rarefy(input_abundance, sample=raremax, se=FALSE, MARGIN=1)
46 #if "output_richness" in $include_files:
47 write.table(Srare, "${output_richness}", col.names=NA, sep = "\t")
48 #end if
49
50 #if "output_slope" in $include_files:
51 write.table(rareslope(input_abundance, sample=raremax+raremax_offset), "${output_slope}", sep = "\t")
52 #end if
53
54 S <- specnumber(input_abundance)
55 #if "output_species_count" in $include_files:
56 write.table(S, "${ output_species_count }", col.names=NA, sep="\t" )
57 #end if
58
59 #if "output_species_frequency" in $include_files:
60 write.table(specnumber(input_abundance, MARGIN=2), "${ output_species_frequency }", col.names=NA, sep="\t" )
61 #end if
62
63 #if "output_species_probabilities" in $include_files:
64 write.table(drarefy(input_abundance, sample=raremax+raremax_offset), "${ output_species_probabilities }", col.names=NA, sep="\t" )
65 #end if
66
67 #if "output_plot" in $include_files:
68 png('${output_plot}', width=1020, height=800, units='px')
69 rarecurve(input_abundance, step = ${step_size}, sample = raremax, xlab = "${xlab}", ylab = "${ylab}", label="${label}", col = "blue", cex = 0.6)
70 invisible(dev.off())
71 #end if
72 ]]>
73 </configfile>
74 </configfiles>
75 <inputs>
76 <param name="input_abundance" type="data" format="tabular" label="File with abundance values for community" help="Rows are samples; columns are species/phyla/community classifier"/>
77 <param name="species_column" label="Group name column" type="data_column" data_ref="input_abundance" value="6" help="Species, phylum, etc"/>
78 <param name="sample_columns" label="Sample count columns" type="data_column" multiple="True" value="2" data_ref="input_abundance" help="Select each column that contains counts"/>
79 <param name="sample_size" type="integer" value="" min="1" optional="True" label="Subsample size for rarefying community" help="Leave empty to subsample by community size for the smallest sample."/>
80 <param name="step_size" type="integer" value="1" min="1" label="Step size for sample sizes"/>
81 <param name="xlab" type="text" value="Sample Size" label="X-axis label"/>
82 <param name="ylab" type="text" value="Species" label="Y-axis label"/>
83 <param name="label" type="boolean" truevalue="TRUE" falsevalue="FALSE" checked="True" label="Label rarefaction curves by rownames of X"/>
84 <param name="include_outputs" type="select" multiple="True" label="Datasets to create">
85 <option value="output_species_count" selected="true">Count of species</option>
86 <option value="output_species_frequency" selected="true">Species frequency</option>
87 <option value="output_richness" selected="true">Richness</option>
88 <option value="output_species_probabilities" selected="true">Species probabilities</option>
89 <option value="output_slope" selected="true">Slope of rarefaction curve</option>
90 <option value="output_r_script" selected="false">R script</option>
91 <option value="output_plot" selected="true">Rarefaction plot</option>
92 </param>
93 </inputs>
94 <outputs>
95 <data format="tabular" name="output_species_count" label="${tool.name} on ${on_string} (number of species)">
96 <filter>"output_species_count" in include_outputs</filter>
97 </data>
98 <data format="tabular" name="output_species_frequency" label="${tool.name} on ${on_string} (frequency of species)">
99 <filter>"output_species_frequency" in include_outputs</filter>
100 </data>
101 <data format="tabular" name="output_richness" label="${tool.name} on ${on_string} (estimated richness)">
102 <filter>"output_richness" in include_outputs</filter>
103 </data>
104 <data format="tabular" name="output_species_probabilities" label="${tool.name} on ${on_string} (species probabilities)">
105 <filter>"output_species_probabilities" in include_outputs</filter>
106 </data>
107 <data format="tabular" name="output_slope" label="${tool.name} on ${on_string} (slope of curve)">
108 <filter>"output_slope" in include_outputs</filter>
109 </data>
110 <data format="txt" name="output_r_script" label="${tool.name} on ${on_string} (Rscript)">
111 <filter>"output_r_script" in include_outputs</filter>
112 </data>
113 <data format="png" name="output_plot" label="${tool.name} on ${on_string} (plot)">
114 <filter>"output_plot" in include_outputs</filter>
115 </data>
116 </outputs>
117 <tests>
118 <test>
119 <param name="input_abundance" ftype="tabular" value="vegan_in.tabular"/>
120 <param name="species_column" value="6"/>
121 <param name="sample_columns" value="2"/>
122 <param name="sample_size" value=""/>
123 <param name="step_size" value="1"/>
124 <param name="xlab" value="Sample Size"/>
125 <param name="ylab" value="Species"/>
126 <param name="label" value="TRUE"/>
127 <output name="output_species_count" ftype="tabular" file="vegan_output_species_count.tabular" />
128 <output name="output_species_frequency" ftype="tabular" file="vegan_output_species_frequency.tabular" />
129 <output name="output_richness" ftype="tabular" file="vegan_output_richness.tabular" />
130 <output name="output_species_probabilities" ftype="tabular" file="vegan_output_species_probabilities.tabular" />
131 <output name="output_slope" ftype="tabular" file="vegan_output_slope.tabular" />
132 </test>
133 </tests>
134 <help>
135 <![CDATA[
136
137 Gives the expected species richness in random subsamples of size sample from the community. The size of sample should be smaller than total community size, but the function will work for larger sample as well (with a warning) and return non-rarefied species richness (and standard error = 0). Rarefaction can be performed only with genuine counts of individuals. The function rarefy is based on Hurlbert’s (1971) formulation, and the standard errors on Heck et al. (1975).
138
139 Returns probabilities that species occur in a rarefied community of size sample.
140
141 Draws a rarefaction curve for each row of the input data. The rarefaction curves are evaluated using the interval of step sample sizes, always including 1 and total sample size. If sample is specified, a vertical line is drawn at sample with horizontal lines for the rarefied species richnesses.
142
143
144 .. class:: warningmark
145
146 When subsampling by community size, slope of the rarefaction curve and species probabilities are computed using community size-1
147 ]]>
148 </help>
149 <citations>
150 </citations>
151 </tool>