annotate qiime2/qiime_quality-control_evaluate-seqs.xml @ 29:3ba9833030c1 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 13:12:49 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
29
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_quality-control_evaluate-seqs" name="qiime quality-control evaluate-seqs"
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Compare query (observed) vs. reference (expected) sequences.</description>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
9 qiime quality-control evaluate-seqs
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
10
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
11 --i-query-sequences=$iquerysequences
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
12
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
13 --i-reference-sequences=$ireferencesequences
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
14
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
15 --o-visualization=ovisualization
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
16
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
17 #if str($examples) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
18 --examples=$examples
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
19 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
20
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
21 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
22 cp odatabase.qza $odatabase
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
23
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
24 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
25 qiime tools export ovisualization.qzv --output-path out
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
26 && mkdir -p '$ovisualization.files_path'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
27 && cp -r out/* '$ovisualization.files_path'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
28 && mv '$ovisualization.files_path/index.html' '$ovisualization'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
29
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
30 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
31 qiime tools export ovisualization.qzv --output-path out
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
32 && mkdir -p '$ovisualization.files_path'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
33 && cp -r out/* '$ovisualization.files_path'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
34 && mv '$ovisualization.files_path/index.html' '$ovisualization'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
35
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
36 ]]></command>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
37 <inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
38 <param format="qza,no_unzip.zip" label="--i-query-sequences: ARTIFACT FeatureData[Sequence] Sequences to test for exclusion [required]" name="iquerysequences" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
39 <param format="qza,no_unzip.zip" label="--i-reference-sequences: ARTIFACT FeatureData[Sequence] Reference sequences to align against feature sequences [required]" name="ireferencesequences" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
40 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
41
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
42 </inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
43
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
44 <outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
45 <data format="html" label="${tool.name} on ${on_string}: visualization.html" name="ovisualization" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
46
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
47 </outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
48
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
49 <help><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
50 Compare query (observed) vs. reference (expected) sequences.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
51 ###############################################################
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
52
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
53 This action aligns a set of query (e.g., observed) sequences against a set
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
54 of reference (e.g., expected) sequences to evaluate the quality of
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
55 alignment. The intended use is to align observed sequences against expected
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
56 sequences (e.g., from a mock community) to determine the frequency of
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
57 mismatches between observed sequences and the most similar expected
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
58 sequences, e.g., as a measure of sequencing/method error. However, any
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
59 sequences may be provided as input to generate a report on pairwise
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
60 alignment quality against a set of reference sequences.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
61
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
62 Parameters
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
63 ----------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
64 query_sequences : FeatureData[Sequence]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
65 Sequences to test for exclusion
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
66 reference_sequences : FeatureData[Sequence]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
67 Reference sequences to align against feature sequences
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
68 show_alignments : Bool, optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
69 Option to plot pairwise alignments of query sequences and their top
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
70 hits.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
71
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
72 Returns
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
73 -------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
74 visualization : Visualization
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
75 ]]></help>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
76 <macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
77 <import>qiime_citation.xml</import>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
78 </macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
79 <expand macro="qiime_citation"/>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
80 </tool>