annotate qiime2/qiime_quality-control_evaluate-seqs.xml @ 0:51b9b6b57732 draft

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