annotate qiime2/qiime_emperor_procrustes-plot.xml @ 0:370e0b6e9826 draft

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