annotate qiime2/qiime_longitudinal_first-distances.xml @ 12:33e7a3470046 draft

Deleted selected files
author florianbegusch
date Thu, 03 Sep 2020 09:44:28 +0000
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_longitudinal_first-distances" name="qiime longitudinal first-distances" version="2019.7">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Compute first distances or distance from baseline between sequential states</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 longitudinal first-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-state-column="$pstatecolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12 --p-individual-id-column="$pindividualidcolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 #if str($pbaseline):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 --p-baseline="$pbaseline"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 #if str($preplicatehandling) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 --p-replicate-handling=$preplicatehandling
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 #if $input_files_mmetadatafile:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 #for d in list_dict[1:]:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 --o-first-distances=ofirstdistances
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 cp ofirstdistances.qza $ofirstdistances
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-distance-matrix: ARTIFACT DistanceMatrix Matrix of distances between pairs of samples. [required]" name="idistancematrix" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 <param label="--p-state-column: TEXT Metadata column containing state (time) variable information. [required]" name="pstatecolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 <param label="--p-individual-id-column: TEXT Metadata column containing IDs for individual subjects. [required]" name="pindividualidcolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 <param label="--p-baseline: NUMBER A value listed in the state-column metadata column against which all other states should be compared. Toggles calculation of static distances instead of first distances (which are calculated if no value is given for baseline). If a 'baseline' value is provided, sample distances at each state are compared against the baseline state, instead of the previous state. Must be a value listed in the state-column. [optional]" name="pbaseline" optional="True" type="float"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 <param label="--p-replicate-handling: " name="preplicatehandling" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 <option value="error">error</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 <option value="random">random</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 <option value="drop">drop</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50
4
florianbegusch
parents: 0
diff changeset
51 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file [required]">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 <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
53 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 <data format="qza" label="${tool.name} on ${on_string}: firstdistances.qza" name="ofirstdistances"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 Compute first distances or distance from baseline between sequential states
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 ###########################################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 Calculates first distances between sequential states for samples collected
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 from individual subjects sampled repeatedly at two or more states. This
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 method is similar to the "first differences" method, except that it
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 requires a distance matrix as input and calculates first differences as
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 distances between successive states. Outputs a data series of first
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 distances for each individual subject at each sequential pair of states,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 labeled by the SampleID of the second state (e.g., paired distances between
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 time 0 and time 1 would be labeled by the SampleIDs at time 1). This file
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 can be used as input to linear mixed effects models or other longitudinal
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 or diversity methods to compare changes in first distances across time or
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 among groups of subjects. Also supports distance from baseline (or other
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 static comparison state) by setting the "baseline" parameter.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 distance_matrix : DistanceMatrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 Matrix of distances between pairs of samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 metadata : Metadata
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 Sample metadata file containing individual_id_column.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 state_column : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 Metadata column containing state (time) variable information.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 individual_id_column : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 Metadata column containing IDs for individual subjects.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 baseline : Float, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 A value listed in the state_column metadata column against which all
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 other states should be compared. Toggles calculation of static
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 distances instead of first distances (which are calculated if no value
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 is given for baseline). If a "baseline" value is provided, sample
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 distances at each state are compared against the baseline state,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 instead of the previous state. Must be a value listed in the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 state_column.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 replicate_handling : Str % Choices('error', 'random', 'drop'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 Choose how replicate samples are handled. If replicates are detected,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 "error" causes method to fail; "drop" will discard all replicated
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 samples; "random" chooses one representative at random from among
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 replicates.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 first_distances : SampleData[FirstDifferences]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 Series of first distances.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 </tool>