annotate qiime2/qiime_emperor_procrustes-plot.xml @ 9:f190567fe3f6 draft

Uploaded
author florianbegusch
date Wed, 14 Aug 2019 15:12:48 -0400
parents 914fa4daf16a
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_procrustes-plot" name="qiime emperor procrustes-plot" version="2019.7">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Visualize and Interact with a procrustes plot</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 procrustes-plot
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-reference-pcoa=$ireferencepcoa
4
florianbegusch
parents: 0
diff changeset
11
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12 --i-other-pcoa=$iotherpcoa
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 #if $input_files_mmetadatafile:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 #for d in list_dict[1:]:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27
4
florianbegusch
parents: 0
diff changeset
28 #if '__sq__' in str($pcustomaxes):
florianbegusch
parents: 0
diff changeset
29 #set $pcustomaxes_temp = $pcustomaxes.replace('__sq__', "'")
florianbegusch
parents: 0
diff changeset
30 #set $pcustomaxes = $pcustomaxes_temp
florianbegusch
parents: 0
diff changeset
31 #end if
florianbegusch
parents: 0
diff changeset
32
florianbegusch
parents: 0
diff changeset
33 #if '__cb__' in str($pcustomaxes):
florianbegusch
parents: 0
diff changeset
34 #set $pcustomaxes_temp = $pcustomaxes.replace('__cb__', "]")
florianbegusch
parents: 0
diff changeset
35 #set $pcustomaxes = $pcustomaxes_temp
florianbegusch
parents: 0
diff changeset
36 #end if
florianbegusch
parents: 0
diff changeset
37
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 #if str($pcustomaxes):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 --p-custom-axes="$pcustomaxes"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41
4
florianbegusch
parents: 0
diff changeset
42
florianbegusch
parents: 0
diff changeset
43
florianbegusch
parents: 0
diff changeset
44
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 #if $pignoremissingsamples:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 --p-ignore-missing-samples
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 --o-visualization=ovisualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 qiime tools export --input-path ovisualization.qzv --output-path out && mkdir -p '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 && cp -r out/* '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 && mv '$ovisualization.files_path/index.html' '$ovisualization'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 <param format="qza,no_unzip.zip" label="--i-reference-pcoa: ARTIFACT PCoAResults The reference ordination matrix to be plotted. [required]" name="ireferencepcoa" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 <param format="qza,no_unzip.zip" label="--i-other-pcoa: ARTIFACT PCoAResults The 'other' ordination matrix to be plotted (the one that was fitted to the reference). [required]" name="iotherpcoa" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 <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
59 <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
60
4
florianbegusch
parents: 0
diff changeset
61 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file [required]">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 <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
63 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 Visualize and Interact with a procrustes plot
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 #############################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 Plot two procrustes-fitted matrices
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 reference_pcoa : PCoAResults
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 The reference ordination matrix to be plotted.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 other_pcoa : PCoAResults
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 The "other" ordination matrix to be plotted (the one that was fitted to
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 the reference).
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 metadata : Metadata
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 The sample metadata.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 custom_axes : List[Str], optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 Numeric sample metadata columns that should be included as axes in the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 Emperor plot.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 ignore_missing_samples : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 This will suppress the error raised when the coordinates matrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 contains samples that are not present in the metadata. Samples without
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 metadata are included by setting all metadata values to: "This sample
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 has no metadata". This flag is only applied if at least one sample is
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 present in both the coordinates matrix and the metadata.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 visualization : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 </tool>