annotate qiime2-2020.8/qiime_demux_filter-samples.xml @ 20:d93d8888f0b0 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 12:44:24 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_demux_filter-samples" name="qiime demux filter-samples"
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Filter samples out of demultiplexed data.</description>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
9 qiime demux filter-samples
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
10
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
11 --i-demux=$idemux
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
12 # if $input_files_mmetadatafile:
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
13 # def list_dict_to_string(list_dict):
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
14 # set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
15 # for d in list_dict[1:]:
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
16 # set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
17 # end for
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
18 # return $file_list
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
19 # end def
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
20 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
21 # end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
22
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
23 #if '__ob__' in str($pwhere):
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
24 #set $pwhere_temp = $pwhere.replace('__ob__', '[')
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
25 #set $pwhere = $pwhere_temp
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
26 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
27 #if '__cb__' in str($pwhere):
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
28 #set $pwhere_temp = $pwhere.replace('__cb__', ']')
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
29 #set $pwhere = $pwhere_temp
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
30 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
31 #if 'X' in str($pwhere):
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
32 #set $pwhere_temp = $pwhere.replace('X', '\\')
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
33 #set $pwhere = $pwhere_temp
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
34 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
35 #if '__sq__' in str($pwhere):
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
36 #set $pwhere_temp = $pwhere.replace('__sq__', "'")
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
37 #set $pwhere = $pwhere_temp
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
38 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
39 #if '__db__' in str($pwhere):
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
40 #set $pwhere_temp = $pwhere.replace('__db__', '"')
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
41 #set $pwhere = $pwhere_temp
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
42 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
43
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
44 #if str($pwhere):
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
45 --p-where=$pwhere
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
46 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
47
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
48 #if $pexcludeids:
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
49 --p-exclude-ids
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
50 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
51
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
52 --o-filtered-demux=ofiltereddemux
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
53
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
54 #if str($examples) != 'None':
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
55 --examples=$examples
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
56 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
57
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
58 ;
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
59 cp ofiltereddemux.qza $ofiltereddemux
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
60
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
61 ]]></command>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
62 <inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
63 <param format="qza,no_unzip.zip" label="--i-demux: ARTIFACT SampleData[SequencesWithQuality¹ | PairedEndSequencesWithQuality² | JoinedSequencesWithQuality³] The demultiplexed data from which samples should be filtered. [required]" name="idemux" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
64 <repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
65 <param format="tabular,qza,no_unzip.zip" label="--m-metadata-file: METADATA... (multiple Sample metadata indicating which sample ids to filter. arguments will The optional `where` parameter may be used to filter be merged) ids based on specified conditions in the metadata. The optional `exclude-ids` parameter may be used to exclude the ids specified in the metadata from the filter. [required]" name="additional_input" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
66 </repeat>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
67 <param label="--p-where: TEXT Optional SQLite WHERE clause specifying sample metadata criteria that must be met to be included in the filtered data. If not provided, all samples in `metadata` that are also in the demultiplexed data will be retained. [optional]" name="pwhere" optional="False" type="text" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
68 <param label="--p-exclude-ids: --p-exclude-ids: / --p-no-exclude-ids Defaults to False. If True, the samples selected by the `metadata` and optional `where` parameter will be excluded from the filtered data. [default: False]" name="pexcludeids" selected="False" type="boolean" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
69 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
70
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
71 </inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
72
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
73 <outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
74 <data format="qza" label="${tool.name} on ${on_string}: filtereddemux.qza" name="ofiltereddemux" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
75
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
76 </outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
77
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
78 <help><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
79 Filter samples out of demultiplexed data.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
80 ###############################################################
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
81
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
82 Filter samples indicated in given metadata out of demultiplexed data.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
83 Specific samples can be further selected with the WHERE clause, and the
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
84 `exclude_ids` parameter allows for filtering of all samples not specified.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
85
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
86 Parameters
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
87 ----------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
88 demux : SampleData[SequencesWithQuality¹ | PairedEndSequencesWithQuality² | JoinedSequencesWithQuality³]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
89 The demultiplexed data from which samples should be filtered.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
90 metadata : Metadata
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
91 Sample metadata indicating which sample ids to filter. The optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
92 `where` parameter may be used to filter ids based on specified
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
93 conditions in the metadata. The optional `exclude_ids` parameter may be
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
94 used to exclude the ids specified in the metadata from the filter.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
95 where : Str, optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
96 Optional SQLite WHERE clause specifying sample metadata criteria that
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
97 must be met to be included in the filtered data. If not provided, all
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
98 samples in `metadata` that are also in the demultiplexed data will be
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
99 retained.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
100 exclude_ids : Bool, optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
101 Defaults to False. If True, the samples selected by the `metadata` and
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
102 optional `where` parameter will be excluded from the filtered data.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
103
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
104 Returns
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
105 -------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
106 filtered_demux : SampleData[SequencesWithQuality¹ | PairedEndSequencesWithQuality² | JoinedSequencesWithQuality³]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
107 Filtered demultiplexed data.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
108 ]]></help>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
109 <macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
110 <import>qiime_citation.xml</import>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
111 </macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
112 <expand macro="qiime_citation"/>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
113 </tool>