annotate qiime/make_2d_plots.xml @ 0:003162f90751 draft

Uploaded
author azuzolo
date Wed, 06 Jun 2012 16:40:30 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
003162f90751 Uploaded
azuzolo
parents:
diff changeset
1 <tool id="make_2d_plots" name="make_2d_plots" version="2.0.0">
003162f90751 Uploaded
azuzolo
parents:
diff changeset
2 <description>Make 2D PCoA Plots</description>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
3 <requirements>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
4 <requirement type="binary">make_2d_plots.py</requirement>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
5 </requirements>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
6 <command interpreter="python">
003162f90751 Uploaded
azuzolo
parents:
diff changeset
7 qiime_wrapper.py
003162f90751 Uploaded
azuzolo
parents:
diff changeset
8 --galaxy_outputdir=$plot.extra_files_path
003162f90751 Uploaded
azuzolo
parents:
diff changeset
9 ##--galaxy_tmpdir='$__new_file_path__'
003162f90751 Uploaded
azuzolo
parents:
diff changeset
10 ##--galaxy_datasets='^\S+_2D_PCoA_plots\.html$:'$plot
003162f90751 Uploaded
azuzolo
parents:
diff changeset
11 --galaxy_datasets='^\S+\.html$:'$plot
003162f90751 Uploaded
azuzolo
parents:
diff changeset
12 ##--galaxy_datasetid=$output1.id
003162f90751 Uploaded
azuzolo
parents:
diff changeset
13 ##--galaxy_new_files_path='$__new_file_path__'
003162f90751 Uploaded
azuzolo
parents:
diff changeset
14 ##--galaxy_tmpdir='$__new_file_path__'
003162f90751 Uploaded
azuzolo
parents:
diff changeset
15 make_2d_plots.py
003162f90751 Uploaded
azuzolo
parents:
diff changeset
16 --coord_fname=$coord_fname
003162f90751 Uploaded
azuzolo
parents:
diff changeset
17 --map_fname=$map_fname
003162f90751 Uploaded
azuzolo
parents:
diff changeset
18 #if $colorby != None and $colorby.__str__ != 'None':
003162f90751 Uploaded
azuzolo
parents:
diff changeset
19 --colorby=$colorby
003162f90751 Uploaded
azuzolo
parents:
diff changeset
20 #end if
003162f90751 Uploaded
azuzolo
parents:
diff changeset
21 #if $prefs_path != None and $prefs_path.__str__ != 'None' and len($prefs_path.__str__) > 0:
003162f90751 Uploaded
azuzolo
parents:
diff changeset
22 --prefs_path=$prefs_path
003162f90751 Uploaded
azuzolo
parents:
diff changeset
23 #end if
003162f90751 Uploaded
azuzolo
parents:
diff changeset
24 --background_color=$background_color
003162f90751 Uploaded
azuzolo
parents:
diff changeset
25 --ellipsoid_opacity=$ellipsoid_opacity
003162f90751 Uploaded
azuzolo
parents:
diff changeset
26 --ellipsoid_method=$ellipsoid_method
003162f90751 Uploaded
azuzolo
parents:
diff changeset
27 #if $master_pcoa != None and $master_pcoa.__str__ != 'None' and len($master_pcoa.__str__) > 0:
003162f90751 Uploaded
azuzolo
parents:
diff changeset
28 --master_pcoa=$master_pcoa
003162f90751 Uploaded
azuzolo
parents:
diff changeset
29 #end if
003162f90751 Uploaded
azuzolo
parents:
diff changeset
30 --output_dir=$plot.extra_files_path
003162f90751 Uploaded
azuzolo
parents:
diff changeset
31 </command>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
32 <inputs>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
33 <param name="coord_fname" type="data" format="qiimepca" label="coord_fname"
003162f90751 Uploaded
azuzolo
parents:
diff changeset
34 help="This is the path to the principal coordinates file (i.e., resulting file from principal_coordinates.py). Alternatively, the user can supply a directory containing multiple principal coordinates files. [REQUIRED]"/>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
35 <param name="map_fname" type="data" format="tabular" label="map_fname"
003162f90751 Uploaded
azuzolo
parents:
diff changeset
36 help="This is the metadata mapping file [REQUIRED]"/>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
37 <param name="colorby" type="text" label="colorby"
003162f90751 Uploaded
azuzolo
parents:
diff changeset
38 help="This is the categories to color by in the plots from the user-generated mapping file. The categories must match the name of a column header in the mapping file exactly and multiple categories can be list by comma separating them without spaces. The user can also combine columns in the mapping file by separating the categories by '&#38;&#38;' without spaces [default=color by all; leave blank]"/>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
39 <param name="prefs_path" type="data" format="txt" optional="true" label="prefs_path"
003162f90751 Uploaded
azuzolo
parents:
diff changeset
40 help="This is the user-generated preferences file. NOTE: This is a file with a dictionary containing preferences for the analysis [OPTIONAL]"/>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
41 <param name="background_color" type="text" label="background_color"
003162f90751 Uploaded
azuzolo
parents:
diff changeset
42 help="This is the background color to use in the plots. [default: white]" value="white"/>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
43 <param name="ellipsoid_opacity" type="float" value="0.33" label="ellipsoid_opacity"
003162f90751 Uploaded
azuzolo
parents:
diff changeset
44 help="Used when plotting ellipsoids for jackknifed beta diversity (i.e. using a directory of coord files instead of a single coordfile). Valid range is 0-1. A value of 0 produces completely transparent (invisible) ellipsoids. A value of 1 produces completely opaque ellipsoids. [default=0.33]"/>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
45 <param name="ellipsoid_method" type="select" value="IQR" label="ellipsoid_method"
003162f90751 Uploaded
azuzolo
parents:
diff changeset
46 help="Used when plotting ellipsoids for jackknifed beta diversity (i.e. using a directory of coord files instead of a single coord file). Choose between 'IQR' (The Interquartile Range) and 'sdev' (The standard deviation). [default=IQR]">
003162f90751 Uploaded
azuzolo
parents:
diff changeset
47 <option value="IQR" selected="true">IQR</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
48 <option value="sdev">sdev</option>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
49 </param>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
50 <param name="master_pcoa" type="text" label="master_pcoa"
003162f90751 Uploaded
azuzolo
parents:
diff changeset
51 help="Used only when plotting ellipsoids for jackknifed beta diversity (i.e. using a directory of coord files instead of a single coord file). These coordinates will be the center of each ellipisoid. [default: None; arbitrarily chosen PC matrix will define the center point]"/>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
52 </inputs>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
53 <outputs>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
54 <data format="html" name="plot" label="${tool.name} on ${on_string}"/>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
55 </outputs>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
56 <tests>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
57 </tests>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
58 <help>For more information, see make_2d_plots_ in the Qiime documentation.
003162f90751 Uploaded
azuzolo
parents:
diff changeset
59
003162f90751 Uploaded
azuzolo
parents:
diff changeset
60 Updated and validated 01/18/12 by Amanda Zuzolo, Microbiome Analysis Center, George Mason University, Fairfax, VA
003162f90751 Uploaded
azuzolo
parents:
diff changeset
61
003162f90751 Uploaded
azuzolo
parents:
diff changeset
62 Qiime integration courtesy Jim Johnson, Minnesota Supercomputing Institute, University of Minnesota, Minneapolis, MN
003162f90751 Uploaded
azuzolo
parents:
diff changeset
63
003162f90751 Uploaded
azuzolo
parents:
diff changeset
64 .. _make_2d_plots: http://qiime.org/scripts/make_2d_plots.html</help>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
65 </tool>
003162f90751 Uploaded
azuzolo
parents:
diff changeset
66