|
20
|
1 <?xml version="1.0" ?>
|
|
|
2 <tool id="qiime_diversity_filter-distance-matrix" name="qiime diversity filter-distance-matrix"
|
|
|
3 version="2020.8">
|
|
|
4 <description>Filter samples from a distance matrix.</description>
|
|
|
5 <requirements>
|
|
|
6 <requirement type="package" version="2020.8">qiime2</requirement>
|
|
|
7 </requirements>
|
|
|
8 <command><![CDATA[
|
|
|
9 qiime diversity filter-distance-matrix
|
|
|
10
|
|
|
11 --i-distance-matrix=$idistancematrix
|
|
|
12 # if $input_files_mmetadatafile:
|
|
|
13 # def list_dict_to_string(list_dict):
|
|
|
14 # set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
|
|
|
15 # for d in list_dict[1:]:
|
|
|
16 # set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
|
|
|
17 # end for
|
|
|
18 # return $file_list
|
|
|
19 # end def
|
|
|
20 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
|
|
|
21 # end if
|
|
|
22
|
|
|
23 #if '__ob__' in str($pwhere):
|
|
|
24 #set $pwhere_temp = $pwhere.replace('__ob__', '[')
|
|
|
25 #set $pwhere = $pwhere_temp
|
|
|
26 #end if
|
|
|
27 #if '__cb__' in str($pwhere):
|
|
|
28 #set $pwhere_temp = $pwhere.replace('__cb__', ']')
|
|
|
29 #set $pwhere = $pwhere_temp
|
|
|
30 #end if
|
|
|
31 #if 'X' in str($pwhere):
|
|
|
32 #set $pwhere_temp = $pwhere.replace('X', '\\')
|
|
|
33 #set $pwhere = $pwhere_temp
|
|
|
34 #end if
|
|
|
35 #if '__sq__' in str($pwhere):
|
|
|
36 #set $pwhere_temp = $pwhere.replace('__sq__', "'")
|
|
|
37 #set $pwhere = $pwhere_temp
|
|
|
38 #end if
|
|
|
39 #if '__db__' in str($pwhere):
|
|
|
40 #set $pwhere_temp = $pwhere.replace('__db__', '"')
|
|
|
41 #set $pwhere = $pwhere_temp
|
|
|
42 #end if
|
|
|
43
|
|
|
44 #if str($pwhere):
|
|
|
45 --p-where=$pwhere
|
|
|
46 #end if
|
|
|
47
|
|
|
48 #if $pexcludeids:
|
|
|
49 --p-exclude-ids
|
|
|
50 #end if
|
|
|
51
|
|
|
52 --o-filtered-distance-matrix=ofiltereddistancematrix
|
|
|
53
|
|
|
54 #if str($examples) != 'None':
|
|
|
55 --examples=$examples
|
|
|
56 #end if
|
|
|
57
|
|
|
58 ;
|
|
|
59 cp ofiltereddistancematrix.qza $ofiltereddistancematrix
|
|
|
60
|
|
|
61 ]]></command>
|
|
|
62 <inputs>
|
|
|
63 <param format="qza,no_unzip.zip" label="--i-distance-matrix: ARTIFACT DistanceMatrix Distance matrix to filter by sample. [required]" name="idistancematrix" optional="False" type="data" />
|
|
|
64 <repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file">
|
|
|
65 <param format="tabular,qza,no_unzip.zip" label="--m-metadata-file: METADATA... (multiple Sample metadata used with `where` parameter when arguments will selecting samples to retain, or with `exclude-ids` when be merged) selecting samples to discard. [required]" name="additional_input" optional="False" type="data" />
|
|
|
66 </repeat>
|
|
|
67 <param label="--p-where: TEXT SQLite WHERE clause specifying sample metadata criteria that must be met to be included in the filtered distance matrix. If not provided, all samples in `metadata` that are also in the input distance matrix will be retained. [optional]" name="pwhere" optional="False" type="text" />
|
|
|
68 <param label="--p-exclude-ids: --p-exclude-ids: / --p-no-exclude-ids If `True`, the samples selected by `metadata` or `where` parameters will be excluded from the filtered distance matrix instead of being retained. [default: False]" name="pexcludeids" selected="False" type="boolean" />
|
|
|
69 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
|
|
|
70
|
|
|
71 </inputs>
|
|
|
72
|
|
|
73 <outputs>
|
|
|
74 <data format="qza" label="${tool.name} on ${on_string}: filtereddistancematrix.qza" name="ofiltereddistancematrix" />
|
|
|
75
|
|
|
76 </outputs>
|
|
|
77
|
|
|
78 <help><![CDATA[
|
|
|
79 Filter samples from a distance matrix.
|
|
|
80 ###############################################################
|
|
|
81
|
|
|
82 Filter samples from a distance matrix, retaining only the samples matching
|
|
|
83 search criteria specified by `metadata` and `where` parameters (or
|
|
|
84 retaining only the samples not matching that criteria, if `exclude_ids` is
|
|
|
85 True). See the filtering tutorial on https://docs.qiime2.org for additional
|
|
|
86 details.
|
|
|
87
|
|
|
88 Parameters
|
|
|
89 ----------
|
|
|
90 distance_matrix : DistanceMatrix
|
|
|
91 Distance matrix to filter by sample.
|
|
|
92 metadata : Metadata
|
|
|
93 Sample metadata used with `where` parameter when selecting samples to
|
|
|
94 retain, or with `exclude_ids` when selecting samples to discard.
|
|
|
95 where : Str, optional
|
|
|
96 SQLite WHERE clause specifying sample metadata criteria that must be
|
|
|
97 met to be included in the filtered distance matrix. If not provided,
|
|
|
98 all samples in `metadata` that are also in the input distance matrix
|
|
|
99 will be retained.
|
|
|
100 exclude_ids : Bool, optional
|
|
|
101 If `True`, the samples selected by `metadata` or `where` parameters
|
|
|
102 will be excluded from the filtered distance matrix instead of being
|
|
|
103 retained.
|
|
|
104
|
|
|
105 Returns
|
|
|
106 -------
|
|
|
107 filtered_distance_matrix : DistanceMatrix
|
|
|
108 Distance matrix filtered to include samples matching search criteria
|
|
|
109 ]]></help>
|
|
|
110 <macros>
|
|
|
111 <import>qiime_citation.xml</import>
|
|
|
112 </macros>
|
|
|
113 <expand macro="qiime_citation"/>
|
|
|
114 </tool> |
