annotate vegan_rarefaction.xml @ 1:da3fbdaaec5b draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/vegan_rarefaction commit f28e850b6791f352750f23956d692aa835fc42af
author devteam
date Wed, 26 Aug 2015 17:19:25 -0400
parents cc2380c0cf10
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
1 <tool id="vegan_rarefaction" name="Vegan Rarefaction" version="0.0.1">
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
2 <description>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
3 curve and statistics
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
4 </description>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
5 <requirements>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
6 <requirement type="package" version="3.2.1">R</requirement>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
7 <requirement type="package" version="2.3-0">vegan</requirement>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
8 </requirements>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
9 <stdio>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
10 <exit_code range="1:" />
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
11 <exit_code range=":-1" />
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
12 </stdio>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
13 <command><![CDATA[
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
14 #if "output_r_script" in str( $include_outputs ).split( "," ):
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
15 cp "${vegan_rarefaction_script}" "${output_r_script}" &&
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
16 #end if
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
17 Rscript "${vegan_rarefaction_script}"
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
18 ]]>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
19 </command>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
20 <configfiles>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
21 <configfile name="vegan_rarefaction_script"><![CDATA[
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
22 #set $include_files = str( $include_outputs ).split( "," )
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
23 #set $int_species_column = int( str( $species_column ) )
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
24 #set $fixed_sample_columns = []
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
25 #for $sample_col in map( int, str( $sample_columns ).split( "," ) ):
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
26 #assert $sample_col != $int_species_column, "Sample label column and sample count columns must not be the same."
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
27 #silent $fixed_sample_columns.append( str( $sample_col if $sample_col < $int_species_column else $sample_col-1 ) )
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
28 #end for
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
29 options(bitmapType='cairo')## No X11, so we'll use cairo
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
30 library(vegan)
1
da3fbdaaec5b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/vegan_rarefaction commit f28e850b6791f352750f23956d692aa835fc42af
devteam
parents: 0
diff changeset
31 input_abundance <- read.table("${input_abundance}", sep="\t", row.names=${ species_column }, header=${header} )
0
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
32
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
33 input_abundance <- t( input_abundance[ c( ${ ",".join( $fixed_sample_columns ) } )] )
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
34
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
35 #if str( $sample_size ) == '':
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
36 raremax <- min(rowSums(input_abundance))
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
37 raremax_offset <- -1
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
38 sprintf("Automatically determining subsampling size, will apply offset to slope calculation and species probabilities.")
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
39 #else:
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
40 raremax = $sample_size
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
41 raremax_offset <- 0
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
42 #end if
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
43 sprintf("Using sample size: %i", raremax)
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
44 Srare <- rarefy(input_abundance, sample=raremax, se=FALSE, MARGIN=1)
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
45 #if "output_richness" in $include_files:
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
46 write.table(Srare, "${output_richness}", col.names=NA, sep = "\t")
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
47 #end if
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
48
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
49 #if "output_slope" in $include_files:
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
50 write.table(rareslope(input_abundance, sample=raremax+raremax_offset), "${output_slope}", sep = "\t")
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
51 #end if
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
52
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
53 S <- specnumber(input_abundance)
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
54 #if "output_species_count" in $include_files:
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
55 write.table(S, "${ output_species_count }", col.names=NA, sep="\t" )
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
56 #end if
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
57
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
58 #if "output_species_frequency" in $include_files:
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
59 write.table(specnumber(input_abundance, MARGIN=2), "${ output_species_frequency }", col.names=NA, sep="\t" )
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
60 #end if
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
61
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
62 #if "output_species_probabilities" in $include_files:
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
63 write.table(drarefy(input_abundance, sample=raremax+raremax_offset), "${ output_species_probabilities }", col.names=NA, sep="\t" )
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
64 #end if
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
65
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
66 #if "output_plot" in $include_files:
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
67 png('${output_plot}', width=1020, height=800, units='px')
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
68 rarecurve(input_abundance, step = ${step_size}, sample = raremax, xlab = "${xlab}", ylab = "${ylab}", label="${label}", col = "blue", cex = 0.6)
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
69 invisible(dev.off())
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
70 #end if
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
71 ]]>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
72 </configfile>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
73 </configfiles>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
74 <inputs>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
75 <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"/>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
76 <param name="species_column" label="Group name column" type="data_column" data_ref="input_abundance" value="6" help="Species, phylum, etc"/>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
77 <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"/>
1
da3fbdaaec5b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/vegan_rarefaction commit f28e850b6791f352750f23956d692aa835fc42af
devteam
parents: 0
diff changeset
78 <param name="header" type="boolean" truevalue="TRUE" falsevalue="FALSE" checked="False" label="Input has a header line"/>
0
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
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."/>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
80 <param name="step_size" type="integer" value="1" min="1" label="Step size for sample sizes"/>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
81 <param name="xlab" type="text" value="Sample Size" label="X-axis label"/>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
82 <param name="ylab" type="text" value="Species" label="Y-axis label"/>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
83 <param name="label" type="boolean" truevalue="TRUE" falsevalue="FALSE" checked="True" label="Label rarefaction curves by rownames of X"/>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
84 <param name="include_outputs" type="select" multiple="True" label="Datasets to create">
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
85 <option value="output_species_count" selected="true">Count of species</option>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
86 <option value="output_species_frequency" selected="true">Species frequency</option>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
87 <option value="output_richness" selected="true">Richness</option>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
88 <option value="output_species_probabilities" selected="true">Species probabilities</option>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
89 <option value="output_slope" selected="true">Slope of rarefaction curve</option>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
90 <option value="output_r_script" selected="false">R script</option>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
91 <option value="output_plot" selected="true">Rarefaction plot</option>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
92 </param>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
93 </inputs>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
94 <outputs>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
95 <data format="tabular" name="output_species_count" label="${tool.name} on ${on_string} (number of species)">
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
96 <filter>"output_species_count" in include_outputs</filter>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
97 </data>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
98 <data format="tabular" name="output_species_frequency" label="${tool.name} on ${on_string} (frequency of species)">
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
99 <filter>"output_species_frequency" in include_outputs</filter>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
100 </data>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
101 <data format="tabular" name="output_richness" label="${tool.name} on ${on_string} (estimated richness)">
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
102 <filter>"output_richness" in include_outputs</filter>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
103 </data>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
104 <data format="tabular" name="output_species_probabilities" label="${tool.name} on ${on_string} (species probabilities)">
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
105 <filter>"output_species_probabilities" in include_outputs</filter>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
106 </data>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
107 <data format="tabular" name="output_slope" label="${tool.name} on ${on_string} (slope of curve)">
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
108 <filter>"output_slope" in include_outputs</filter>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
109 </data>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
110 <data format="txt" name="output_r_script" label="${tool.name} on ${on_string} (Rscript)">
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
111 <filter>"output_r_script" in include_outputs</filter>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
112 </data>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
113 <data format="png" name="output_plot" label="${tool.name} on ${on_string} (plot)">
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
114 <filter>"output_plot" in include_outputs</filter>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
115 </data>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
116 </outputs>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
117 <tests>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
118 <test>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
119 <param name="input_abundance" ftype="tabular" value="vegan_in.tabular"/>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
120 <param name="species_column" value="6"/>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
121 <param name="sample_columns" value="2"/>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
122 <param name="sample_size" value=""/>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
123 <param name="step_size" value="1"/>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
124 <param name="xlab" value="Sample Size"/>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
125 <param name="ylab" value="Species"/>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
126 <param name="label" value="TRUE"/>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
127 <output name="output_species_count" ftype="tabular" file="vegan_output_species_count.tabular" />
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
128 <output name="output_species_frequency" ftype="tabular" file="vegan_output_species_frequency.tabular" />
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
129 <output name="output_richness" ftype="tabular" file="vegan_output_richness.tabular" />
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
130 <output name="output_species_probabilities" ftype="tabular" file="vegan_output_species_probabilities.tabular" />
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
131 <output name="output_slope" ftype="tabular" file="vegan_output_slope.tabular" />
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
132 </test>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
133 </tests>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
134 <help>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
135 <![CDATA[
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
136
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
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).
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
138
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
139 Returns probabilities that species occur in a rarefied community of size sample.
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
140
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
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.
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
142
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
143
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
144 .. class:: warningmark
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
145
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
146 When subsampling by community size, slope of the rarefaction curve and species probabilities are computed using community size-1
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
147 ]]>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
148 </help>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
149 <citations>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
150 </citations>
cc2380c0cf10 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/packages/vegan_rarefaction commit 5ad726dc73203a704666033cd3bf70b82575978f-dirty
devteam
parents:
diff changeset
151 </tool>