annotate qiime2/qiime_longitudinal_pairwise-distances.xml @ 2:51025741f326 draft

Uploaded
author florianbegusch
date Thu, 18 Jul 2019 12:19:15 -0400
parents 370e0b6e9826
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_longitudinal_pairwise-distances" name="qiime longitudinal pairwise-distances" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Paired pairwise distance testing and boxplots</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 longitudinal pairwise-distances
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-distance-matrix=$idistancematrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --p-group-column="$pgroupcolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12 --p-state-column="$pstatecolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13 --p-state-1="$pstate1"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 --p-state-2="$pstate2"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 --p-individual-id-column="$pindividualidcolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #if $pparametric:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 --p-parametric
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 #if str($ppalette) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 --p-palette=$ppalette
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 #if str($preplicatehandling) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 --p-replicate-handling=$preplicatehandling
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 #if $input_files_mmetadatafile:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 #for d in list_dict[1:]:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 --o-visualization=ovisualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 qiime tools export --input-path ovisualization.qzv --output-path out && mkdir -p '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 && cp -r out/* '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 && mv '$ovisualization.files_path/index.html' '$ovisualization';
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 <param format="qza,no_unzip.zip" label="--i-distance-matrix: ARTIFACT DistanceMatrix Matrix of distances between pairs of samples. [required]" name="idistancematrix" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 <param label="--p-group-column: TEXT Metadata column on which to separate groups for comparison [required]" name="pgroupcolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 <param label="--p-state-column: TEXT Metadata column containing state (e.g., Time) across which samples are paired. [required]" name="pstatecolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 <param label="--p-state-1: TEXT Baseline state column value. [required]" name="pstate1" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 <param label="--p-state-2: TEXT State column value to pair with baseline. [required]" name="pstate2" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 <param label="--p-individual-id-column: TEXT Metadata column containing subject IDs to use for pairing samples. WARNING: if replicates exist for an individual ID at either state-1 or state-2, that subject will be dropped and reported in standard output by default. Set replicate_handling='random' to instead randomly select one member. [required]" name="pindividualidcolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 <param label="--p-parametric: --p-no-parametric Perform parametric (ANOVA and t-tests) or non-parametric (Kruskal-Wallis, Wilcoxon, and Mann-Whitney U tests) statistical tests. [default: False]" name="pparametric" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 <param label="--p-palette: " name="ppalette" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 <option value="Set1">Set1</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <option value="Set2">Set2</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 <option value="Set3">Set3</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 <option value="Pastel1">Pastel1</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 <option value="Pastel2">Pastel2</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 <option value="Paired">Paired</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 <option value="Accent">Accent</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 <option value="Dark2">Dark2</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 <option value="tab10">tab10</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 <option value="tab20">tab20</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 <option value="tab20b">tab20b</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 <option value="tab20c">tab20c</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 <option value="viridis">viridis</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 <option value="plasma">plasma</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 <option value="inferno">inferno</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 <option value="magma">magma</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 <option value="terrain">terrain</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 <option value="rainbow">rainbow</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 <param label="--p-replicate-handling: " name="preplicatehandling" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 <option value="error">error</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 <option value="random">random</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 <option value="drop">drop</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 <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
86 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 Paired pairwise distance testing and boxplots
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 #############################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 Performs pairwise distance testing between sample pairs from each subject.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 Sample pairs may represent a typical intervention study, e.g., samples
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 collected pre- and post-treatment; paired samples from two different
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 timepoints (e.g., in a longitudinal study design), or identical samples
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 receiving different two different treatments. This action tests whether the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 pairwise distance between each subject pair differs between groups (e.g.,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 groups of subjects receiving different treatments) and produces boxplots of
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 paired distance distributions for each group.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 distance_matrix : DistanceMatrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 Matrix of distances between pairs of samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 metadata : Metadata
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 Sample metadata file containing individual_id_column.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 group_column : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 Metadata column on which to separate groups for comparison
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 state_column : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 Metadata column containing state (e.g., Time) across which samples are
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 paired.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 state_1 : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 Baseline state column value.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 state_2 : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 State column value to pair with baseline.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
119 individual_id_column : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120 Metadata column containing subject IDs to use for pairing samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121 WARNING: if replicates exist for an individual ID at either state_1 or
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122 state_2, that subject will be dropped and reported in standard output
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123 by default. Set replicate_handling="random" to instead randomly select
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 one member.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
125 parametric : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
126 Perform parametric (ANOVA and t-tests) or non-parametric (Kruskal-
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
127 Wallis, Wilcoxon, and Mann-Whitney U tests) statistical tests.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
128 palette : Str % Choices('Set1', 'Set2', 'Set3', 'Pastel1', 'Pastel2', 'Paired', 'Accent', 'Dark2', 'tab10', 'tab20', 'tab20b', 'tab20c', 'viridis', 'plasma', 'inferno', 'magma', 'terrain', 'rainbow'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
129 Color palette to use for generating boxplots.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
130 replicate_handling : Str % Choices('error', 'random', 'drop'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
131 Choose how replicate samples are handled. If replicates are detected,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
132 "error" causes method to fail; "drop" will discard all replicated
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
133 samples; "random" chooses one representative at random from among
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
134 replicates.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
135
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
136 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
137 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
138 visualization : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
139 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
140 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
141 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
142 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
143 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
144 </tool>