annotate qiime2/qiime_longitudinal_first-differences.xml @ 7:85b520815e85 draft

Uploaded
author florianbegusch
date Tue, 13 Aug 2019 07:53:59 -0400
parents de4c22a52df4
children f190567fe3f6
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_first-differences" name="qiime longitudinal first-differences" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Compute first differences or difference from baseline between sequential states</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 first-differences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --p-state-column="$pstatecolumn"
6
florianbegusch
parents: 4
diff changeset
11 --p-metric="$pmetric"
florianbegusch
parents: 4
diff changeset
12
florianbegusch
parents: 4
diff changeset
13
florianbegusch
parents: 4
diff changeset
14
florianbegusch
parents: 4
diff changeset
15 #if '__pd__' in str($pindividualidcolumn):
florianbegusch
parents: 4
diff changeset
16 #set $pwhere_temp = $pindividualidcolumn.replace('__pd__', "#")
florianbegusch
parents: 4
diff changeset
17 #set $pindividualidcolumn = $pwhere_temp
florianbegusch
parents: 4
diff changeset
18 #end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 --p-individual-id-column="$pindividualidcolumn"
6
florianbegusch
parents: 4
diff changeset
20
florianbegusch
parents: 4
diff changeset
21
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 #if str($itable) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 --i-table=$itable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 #if str($preplicatehandling) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 --p-replicate-handling=$preplicatehandling
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 #if str($pbaseline):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 --p-baseline="$pbaseline"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 #if $input_files_mmetadatafile:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 #for d in list_dict[1:]:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 --o-first-differences=ofirstdifferences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 cp ofirstdifferences.qza $ofirstdifferences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 <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
54 <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
55 <param label="--p-metric: TEXT Numerical metadata or artifact column to test. [required]" name="pmetric" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[RelativeFrequency] Feature table to optionally use for computing first differences. [optional]" name="itable" optional="True" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 <param label="--p-replicate-handling: " name="preplicatehandling" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <option value="error">error</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 <option value="random">random</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 <option value="drop">drop</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 <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 differences instead of first differences (which are calculated if no value is given for baseline). If a 'baseline' value is provided, sample differences 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
64
6
florianbegusch
parents: 4
diff changeset
65 <repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file [required]">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 <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
67 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 <data format="qza" label="${tool.name} on ${on_string}: firstdifferences.qza" name="ofirstdifferences"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 Compute first differences or difference from baseline between sequential states
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 ###############################################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 Calculates first differences in "metric" between sequential states for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 samples collected from individual subjects sampled repeatedly at two or
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 more states. First differences can be performed on a metadata column
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 (including artifacts that can be input as metadata) or a feature in a
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 feature table. Outputs a data series of first differences for each
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 individual subject at each sequential pair of states, labeled by the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 SampleID of the second state (e.g., paired differences between time 0 and
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 time 1 would be labeled by the SampleIDs at time 1). This file can be used
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 as input to linear mixed effects models or other longitudinal or diversity
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 methods to compare changes in first differences across time or among groups
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 of subjects. Also supports differences from baseline (or other static
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 comparison state) by setting the "baseline" parameter.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 metadata : Metadata
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 Sample metadata file containing individual_id_column.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 state_column : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 Metadata column containing state (time) variable information.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 individual_id_column : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 Metadata column containing IDs for individual subjects.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 metric : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 Numerical metadata or artifact column to test.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 replicate_handling : Str % Choices('error', 'random', 'drop'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 Choose how replicate samples are handled. If replicates are detected,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 "error" causes method to fail; "drop" will discard all replicated
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 samples; "random" chooses one representative at random from among
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 replicates.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 baseline : Float, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 A value listed in the state_column metadata column against which all
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 other states should be compared. Toggles calculation of static
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 differences instead of first differences (which are calculated if no
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 value is given for baseline). If a "baseline" value is provided, sample
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 differences at each state are compared against the baseline state,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 instead of the previous state. Must be a value listed in the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 state_column.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 table : FeatureTable[RelativeFrequency], optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 Feature table to optionally use for computing first differences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 first_differences : SampleData[FirstDifferences]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
119 Series of first differences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
125 </tool>