annotate tools/emboss_5/emboss_needle.xml @ 2:c2a356708570

Uploaded
author xuebing
date Fri, 09 Mar 2012 19:45:42 -0500
parents 9071e359b9a3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
1 <tool id="EMBOSS: needle56" name="needle" version="5.0.0">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description>Needleman-Wunsch global alignment</description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <requirements><requirement type="package" version="5.0.0">emboss</requirement></requirements>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 <command>needle -asequence $input1 -bsequence $input2 -outfile $out_file1 -gapopen $gapopen -gapextend $gapextend -brief $brief -aformat3 $out_format1 -auto</command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 <param format="fasta" name="input1" type="data">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 <label>Sequence 1</label>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 <param format="fasta" name="input2" type="data">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 <label>Sequence 2</label>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 <param name="gapopen" size="4" type="text" value="10.0">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 <label>Gap open penalty</label>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 <param name="gapextend" size="4" type="text" value="0.5">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 <label>Gap extension penalty</label>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 <param name="brief" type="select">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 <label>Brief identity and similarity</label>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 <option value="yes">Yes</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 <option value="no">No</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 <param name="out_format1" type="select">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 <label>Output Alignment File Format</label>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 <option value="srspair">SRS pair (p)</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 <option value="simple">Simple (m)</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 <option value="fasta">FASTA (m)</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 <option value="msf">MSF (m)</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 <option value="srs">SRS (m)</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 <option value="pair">Pair (p)</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 <option value="markx0">Markx0 (p)</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 <option value="markx1">Markx1 (p)</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 <option value="markx2">Markx2 (p)</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34 <option value="markx3">Markx3 (p)</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 <option value="markx10">Markx10 (p)</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36 <option value="score">Score (p)</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40 <data format="needle" name="out_file1" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44 <param name="input1" value="2.fasta"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45 <param name="input2" value="1.fasta"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46 <param name="gapopen" value="10"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47 <param name="gapextend" value="0.5"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48 <param name="brief" value="yes"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 <param name="out_format1" value="score"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50 <output name="out_file1" file="emboss_needle_out.score"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 <code file="emboss_format_corrector.py" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56 .. class:: warningmark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58 needle reads any two sequences of the same type (DNA or protein).
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62 **Syntax**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64 This tool uses the Needleman-Wunsch global alignment algorithm to find the optimum alignment (including gaps) of two sequences when considering their entire length.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66 - **Optimal alignment:** Dynamic programming methods ensure the optimal global alignment by exploring all possible alignments and choosing the best.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68 - **The Needleman-Wunsch algorithm** is a member of the class of algorithms that can calculate the best score and alignment in the order of mn steps, (where 'n' and 'm' are the lengths of the two sequences).
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70 - **Gap open penalty:** [10.0 for any sequence] The gap open penalty is the score taken away when a gap is created. The best value depends on the choice of comparison matrix. The default value assumes you are using the EBLOSUM62 matrix for protein sequences, and the EDNAFULL matrix for nucleotide sequences. (Floating point number from 1.0 to 100.0)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
71
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
72 - **Gap extension penalty:** [0.5 for any sequence] The gap extension, penalty is added to the standard gap penalty for each base or residue in the gap. This is how long gaps are penalized. Usually you will expect a few long gaps rather than many short gaps, so the gap extension penalty should be lower than the gap penalty. An exception is where one or both sequences are single reads with possible sequencing errors in which case you would expect many single base gaps. You can get this result by setting the gap open penalty to zero (or very low) and using the gap extension penalty to control gap scoring. (Floating point number from 0.0 to 10.0)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
73
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
74 You can view the original documentation here_.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
75
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
76 .. _here: http://emboss.sourceforge.net/apps/release/5.0/emboss/apps/needle.html
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
77
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
78 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
79
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
80 **Example**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
81
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
82 - Input File::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
83
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
84 >hg18_dna range=chrX:151073054-151073136 5'pad=0 3'pad=0 revComp=FALSE strand=? repeatMasking=none
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
85 TTTATGTCTATAATCCTTACCAAAAGTTACCTTGGAATAAGAAGAAGTCA
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
86 GTAAAAAGAAGGCTGTTGTTCCGTGAAATACTG
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
87
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
88 - If both Sequence1 and Sequence2 take the above file as input, Gap open penalty equals 10.0, Gap extension penalty equals 0.5, Brief identity and similarity is set to Yes, Output Alignment File Format is set to SRS pairs, the output file is::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
89
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
90 ########################################
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
91 # Program: needle
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
92 # Rundate: Mon Apr 02 2007 14:23:16
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
93 # Align_format: srspair
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
94 # Report_file: ./database/files/dataset_7.dat
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
95 ########################################
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
96
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
97 #=======================================
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
98 #
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
99 # Aligned_sequences: 2
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
100 # 1: hg18_dna
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
101 # 2: hg18_dna
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
102 # Matrix: EDNAFULL
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
103 # Gap_penalty: 10.0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
104 # Extend_penalty: 0.5
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
105 #
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
106 # Length: 83
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
107 # Identity: 83/83 (100.0%)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
108 # Similarity: 83/83 (100.0%)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
109 # Gaps: 0/83 ( 0.0%)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
110 # Score: 415.0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
111 #
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
112 #=======================================
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
113
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
114 hg18_dna 1 TTTATGTCTATAATCCTTACCAAAAGTTACCTTGGAATAAGAAGAAGTCA 50
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
115 ||||||||||||||||||||||||||||||||||||||||||||||||||
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
116 hg18_dna 1 TTTATGTCTATAATCCTTACCAAAAGTTACCTTGGAATAAGAAGAAGTCA 50
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
117
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
118 hg18_dna 51 GTAAAAAGAAGGCTGTTGTTCCGTGAAATACTG 83
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
119 |||||||||||||||||||||||||||||||||
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
120 hg18_dna 51 GTAAAAAGAAGGCTGTTGTTCCGTGAAATACTG 83
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
121
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
122 #---------------------------------------
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
123 #---------------------------------------
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
124
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
125 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
126 </tool>