annotate qiime2/qiime_emperor_plot.xml @ 10:21c7954105a9 draft

Fix
author florianbegusch
date Sun, 25 Aug 2019 10:26:27 -0400
parents f190567fe3f6
children a0a8d77a991c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
9
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
2 <tool id="qiime_emperor_plot" name="qiime emperor plot" version="2019.7">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Visualize and Interact with Principal Coordinates Analysis Plots</description>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
9
f190567fe3f6 Uploaded
florianbegusch
parents: 4
diff changeset
5 <requirement type="package" version="2019.7">qiime2</requirement>
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
7 <command><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
8 qiime emperor plot
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-pcoa=$ipcoa
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13 #if $input_files_mmetadatafile:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #for d in list_dict[1:]:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 #if str($pcustomaxes):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 --p-custom-axes="$pcustomaxes"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 #if $pignoremissingsamples:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 --p-ignore-missing-samples
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 --o-visualization=ovisualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 qiime tools export --input-path ovisualization.qzv --output-path out && mkdir -p '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 && cp -r out/* '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 && mv '$ovisualization.files_path/index.html' '$ovisualization'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 <param format="qza,no_unzip.zip" label="--i-pcoa: ARTIFACT The principal coordinates matrix to be plotted. PCoAResults [required]" name="ipcoa" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 <param label="--p-custom-axes: TEXT... List[Str] Numeric sample metadata columns that should be included as axes in the Emperor plot. [optional]" name="pcustomaxes" optional="True" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 <param label="--p-ignore-missing-samples: --p-no-ignore-missing-samples This will suppress the error raised when the coordinates matrix contains samples that are not present in the metadata. Samples without metadata are included by setting all metadata values to: 'This sample has no metadata'. This flag is only applied if at least one sample is present in both the coordinates matrix and the metadata. [default: False]" name="pignoremissingsamples" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43
4
florianbegusch
parents: 0
diff changeset
44 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file [required]">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 <param label="--m-metadata-file: Metadata file or artifact viewable as metadata. This option may be supplied multiple times to merge metadata. [optional]" name="additional_input" type="data" format="tabular,qza,no_unzip.zip" />
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 Visualize and Interact with Principal Coordinates Analysis Plots
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 ################################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 Generates an interactive ordination plot where the user can visually
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 integrate sample metadata.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 pcoa : PCoAResults
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 The principal coordinates matrix to be plotted.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 metadata : Metadata
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 The sample metadata.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 custom_axes : List[Str], optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 Numeric sample metadata columns that should be included as axes in the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 Emperor plot.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 ignore_missing_samples : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 This will suppress the error raised when the coordinates matrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 contains samples that are not present in the metadata. Samples without
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 metadata are included by setting all metadata values to: "This sample
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 has no metadata". This flag is only applied if at least one sample is
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 present in both the coordinates matrix and the metadata.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 visualization : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 </tool>