Mercurial > repos > jjohnson > qiime

annotate make_3d_plots.xml @ 0:e5c3175506b7 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial tool configs for qiime, most need work.
author Jim Johnson <jj@umn.edu>
date Sun, 17 Jul 2011 10:30:11 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
1 <tool id="make_3d_plots" name="make_3d_plots" version="1.2.1">
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
2 <description>Make 3D PCoA plots</description>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
3 <requirements>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
4 <requirement type="binary">make_3d_plots.py</requirement>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
5 </requirements>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
6 <command interpreter="python">
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
7 qiime_wrapper.py
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
8 --galaxy_summary_html='$output_html'
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
9 --galaxy_outputdir='$output_html.extra_files_path'
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
10 --galaxy_summary_template='$output_template'
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
11 make_3d_plots.py
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
12 --coord_fname=$coord_fname
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
13 --map_fname=$map_fname
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
14 --colorby=$colorby
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
15 --custom_axes=$custom_axes
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
16 --prefs_path=$prefs_path
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
17 --background_color=$background_color
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
18 --output_dir=$__new_file_path__
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
19 --ellipsoid_smoothness=$ellipsoid_smoothness
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
20 --ellipsoid_opacity=$ellipsoid_opacity
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
21 --ellipsoid_method=$ellipsoid_method
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
22 --taxa_fname=$taxa_fname
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
23 --n_taxa_keep=$n_taxa_keep
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
24 --biplot_output_file=$biplot_output_file
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
25 --master_pcoa=$master_pcoa
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
26 --output_format=$output_format
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
27 --interpolation_points=$interpolation_points
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
28 --polyhedron_points=$polyhedron_points
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
29 --polyhedron_offset=$polyhedron_offset
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
30 </command>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
31 <inputs>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
32 <param name="coord_fname" type="text" label="coord_fname"
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
33 help="This is the path to the principal coordinates file (i.e., resulting file from principal_coordinates.py), or to a directory containing multiple coord files for averaging (e.g. resulting files from multiple_rarefactions_even_depth.py, followed by multiple beta_diversity.py, followed by multiple principal_coordinates.py). [REQUIRED]"/>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
34 <param name="map_fname" type="data" format="tabular" label="map_fname"
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
35 help="This is the metadata mapping file [default=('NO', 'DEFAULT')] [REQUIRED]"/>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
36 <param name="colorby" type="text" label="colorby"
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
37 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=('NO', 'DEFAULT')]"/>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
38 <param name="custom_axes" type="text" label="custom_axes"
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
39 help="This is the category from the user-generated mapping file to use as a custom axis in the plot. For instance,there is a pH category and would like to seethe samples plotted on that axis instead of PC1, PC2, etc., one can use this option. It is also useful for plotting time-series data [default: ('NO', 'DEFAULT')]"/>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
40 <param name="prefs_path" type="text" label="prefs_path"
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
41 help="This is the user-generated preferences file. NOTE: This is a file with a dictionary containing preferences for the analysis [default: ('NO', 'DEFAULT')]"/>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
42 <param name="background_color" type="text" label="background_color"
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
43 help="This is the background color to use in the plots (Options are 'black' or 'white'. [default: ('NO', 'DEFAULT')]"/>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
44 <param name="ellipsoid_smoothness" type="text" value="1" label="ellipsoid_smoothness"
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
45 help="The level of smoothness used in plotting ellipsoids for a summary plot (i.e. using a directory of coord files instead of a single coord file). Valid range is 0-3. A value of 0 produces very coarse 'ellipsoids' but is fast to render. The default value is 2. If you encounter a memory error when generating or displaying the plots, try including just one metadata column in your plot. If you still have trouble, reduce the smoothness level to 0 or 1."/>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
46 <param name="ellipsoid_opacity" type="text" value="0.33" label="ellipsoid_opacity"
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
47 help="Used when plotting ellipsoids for a summary plot (i.e. using a directory of coord files instead of a single coord file). Valid range is 0-3. A value of 0 produces completely transparent (invisible) ellipsoids. A value of 1 produces completely opaque ellipsoids. The default value is 0.33."/>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
48 <param name="ellipsoid_method" type="text" value="IQR" label="ellipsoid_method"
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
49 help="Used when plotting ellipsoids for a summary plot (i.e. using a directory of coord files instead of a single coord file). Valid values are 'IQR' (The Interquartile Range) and 'sdev' (The standard deviation). The default is IQR."/>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
50 <param name="taxa_fname" type="text" label="taxa_fname"
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
51 help="If you wish to perform a biplot, where taxa are plotted along with samples, supply an otu table format file. Typically this is the output from summarize_taxa.py."/>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
52 <param name="n_taxa_keep" type="text" value="10" label="n_taxa_keep"
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
53 help="If performing a biplot, the number of taxa to display; use -1 to display all. [default: 10]"/>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
54 <param name="biplot_output_file" type="data" format="txt" label="biplot_output_file"
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
55 help="If performing a biplot, save the biplot coordinates in this file. [default: %default]"/>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
56 <param name="master_pcoa" type="text" label="master_pcoa"
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
57 help="If performing averaging on multiple coord files, the other coord files will be aligned to this one through procrustes analysis. This master file will not be included in the averaging. If this master coord file is not provided, one of the other coord files will be chosen arbitrarily as the target alignment. [default: %default]"/>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
58 <param name="interpolation_points" type="integer" value="0" label="interpolation_points"
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
59 help="Number of extra points to use between samples and interpolate, the minimum is 2. Only used with the inVUE output. [default: 0]"/>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
60 <param name="polyhedron_points" type="integer" value="4" label="polyhedron_points"
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
61 help="Points to be generated to create a frame around the PCoA plots. Only used when --output_format is inVUE. [default: 4]"/>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
62 <param name="polyhedron_offset" type="float" value="1.5" label="polyhedron_offset"
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
63 help="Offset to be added to the points created in the --polyheadron_points option. Only used when --output_format is inVUE. [default: 1.5]"/>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
64 <param name="output_format"type="select" label="output_format">
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
65 <option value="king" selected="true">king</option>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
66 <option value="invue">invue</option>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
67 </param>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
68 </inputs>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
69 <configfiles>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
70 <configfile name="output_template">
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
71 <![CDATA[
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
72 <html>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
73 <body>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
74 <a href="rarefaction_plots.html">weighted_unifrac_pc.txt_3D.html</a>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
75 </body>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
76 </html>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
77 ]]>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
78 </configfile>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
79 </configfiles>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
80 <outputs>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
81 <data format="html" name="output_html" label="alpha_rarefaction_plots"/>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
82 </outputs>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
83 <tests>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
84 </tests>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
85 <help>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
86
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
87 </help>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
88 </tool>
e5c3175506b7 Initial tool configs for qiime, most need work.
Jim Johnson <jj@umn.edu>
parents:
diff changeset
89