annotate emboss_needle.xml @ 18:63dd26468588 draft default tip

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/emboss_5 commit 18de4aa9ba00124b1b3e3afe14219e46931e58a9"

<tool id="EMBOSS: needle56" name="needle" version="@VERSION@.1">
  <description>Needleman-Wunsch global alignment</description>
  <macros>
    <import>macros.xml</import>
  </macros>
  <expand macro="requirements" />
  <code file="emboss_format_corrector.py" />
  <command>needle -asequence '$input1' -bsequence '$input2' -outfile '$out_file1' -gapopen $gapopen -gapextend $gapextend -brief $brief -aformat3 $out_format1 -auto</command>
  <inputs>
    <param name="input1" type="data" format="fasta" label="Sequence 1" />
    <param name="input2" type="data" format="fasta" label="Sequence 2" />
    <param name="gapopen" type="float" value="10.0" label="Gap open penalty" />
    <param name="gapextend" type="float" value="0.5" label="Gap extension penalty" />
    <param name="brief" type="select" label="Brief identity and similarity">
      <option value="yes">Yes</option>
      <option value="no">No</option>
    </param>
    <param name="out_format1" type="select" label="Output alignment file format">
      <option value="srspair">SRS pair (p)</option>
      <option value="simple">Simple (m)</option>
      <option value="fasta">FASTA (m)</option>
      <option value="msf">MSF (m)</option>
      <option value="srs">SRS (m)</option>
      <option value="pair">Pair (p)</option>
      <option value="markx0">Markx0 (p)</option>
      <option value="markx1">Markx1 (p)</option>
      <option value="markx2">Markx2 (p)</option>
      <option value="markx3">Markx3 (p)</option>
      <option value="markx10">Markx10 (p)</option>
      <option value="score">Score (p)</option>
    </param>
  </inputs>
  <outputs>
    <data name="out_file1" format="needle" />
  </outputs>
  <tests>
    <test>
      <param name="input1" value="2.fasta"/>
      <param name="input2" value="1.fasta"/>
      <param name="gapopen" value="10"/>
      <param name="gapextend" value="0.5"/>
      <param name="brief" value="yes"/>
      <param name="out_format1" value="score"/>
      <output name="out_file1" file="emboss_needle_out.score"/>
    </test>
  </tests>
  <help>
.. class:: warningmark

needle reads any two sequences of the same type (DNA or protein).

-----

**Syntax**

This tool uses the Needleman-Wunsch global alignment algorithm to find the optimum alignment (including gaps) of two sequences when considering their entire length.

- **Optimal alignment:** Dynamic programming methods ensure the optimal global alignment by exploring all possible alignments and choosing the best.

- **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).

- **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)

- **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)

You can view the original documentation here_.

    .. _here: http://galaxy-iuc.github.io/emboss-5.0-docs/needle.html

-----

**Example**

- Input File::

    >hg18_dna range=chrX:151073054-151073136 5'pad=0 3'pad=0 revComp=FALSE strand=? repeatMasking=none
    TTTATGTCTATAATCCTTACCAAAAGTTACCTTGGAATAAGAAGAAGTCA
    GTAAAAAGAAGGCTGTTGTTCCGTGAAATACTG

- 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::

    ########################################
    # Program: needle
    # Rundate: Mon Apr 02 2007 14:23:16
    # Align_format: srspair
    # Report_file: ./database/files/dataset_7.dat
    ########################################

    #=======================================
    #
    # Aligned_sequences: 2
    # 1: hg18_dna
    # 2: hg18_dna
    # Matrix: EDNAFULL
    # Gap_penalty: 10.0
    # Extend_penalty: 0.5
    #
    # Length: 83
    # Identity:      83/83 (100.0%)
    # Similarity:    83/83 (100.0%)
    # Gaps:           0/83 ( 0.0%)
    # Score: 415.0
    #
    #=======================================

    hg18_dna           1 TTTATGTCTATAATCCTTACCAAAAGTTACCTTGGAATAAGAAGAAGTCA     50
                       ||||||||||||||||||||||||||||||||||||||||||||||||||
    hg18_dna           1 TTTATGTCTATAATCCTTACCAAAAGTTACCTTGGAATAAGAAGAAGTCA     50

    hg18_dna          51 GTAAAAAGAAGGCTGTTGTTCCGTGAAATACTG     83
                       |||||||||||||||||||||||||||||||||
    hg18_dna          51 GTAAAAAGAAGGCTGTTGTTCCGTGAAATACTG     83

    #---------------------------------------
    #---------------------------------------
  </help>
  <expand macro="citations" />
</tool>