annotate qiime2/qiime_quality-control_evaluate-seqs.xml @ 10:21c7954105a9 draft

Fix
author florianbegusch
date Sun, 25 Aug 2019 10:26:27 -0400
parents f190567fe3f6
children a0a8d77a991c
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" ?>
9
f190567fe3f6 Uploaded
florianbegusch
parents: 0
diff changeset
2 <tool id="qiime_quality-control_evaluate-seqs" name="qiime quality-control evaluate-seqs" version="2019.7">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Compare query (observed) vs. reference (expected) sequences.</description>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
9
f190567fe3f6 Uploaded
florianbegusch
parents: 0
diff changeset
5 <requirement type="package" version="2019.7">qiime2</requirement>
0
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 quality-control evaluate-seqs
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-query-sequences=$iquerysequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --i-reference-sequences=$ireferencesequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13 --o-visualization=ovisualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 qiime tools export --input-path ovisualization.qzv --output-path out && mkdir -p '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 && cp -r out/* '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 && mv '$ovisualization.files_path/index.html' '$ovisualization';
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 <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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 <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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 Compare query (observed) vs. reference (expected) sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 ############################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 This action aligns a set of query (e.g., observed) sequences against a set
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 of reference (e.g., expected) sequences to evaluate the quality of
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 alignment. The intended use is to align observed sequences against expected
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 sequences (e.g., from a mock community) to determine the frequency of
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 mismatches between observed sequences and the most similar expected
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 sequences, e.g., as a measure of sequencing/method error. However, any
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 sequences may be provided as input to generate a report on pairwise
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 alignment quality against a set of reference sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 query_sequences : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 Sequences to test for exclusion
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 reference_sequences : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 Reference sequences to align against feature sequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 show_alignments : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 Option to plot pairwise alignments of query sequences and their top
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 hits.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 visualization : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 </tool>