annotate align.seqs.xml @ 9:abf7c15ecfef draft default tip

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit dfdd4c590370ecb3a9806314d43eb5668e36a01a"

<tool profile="16.07" id="mothur_align_seqs" name="Align.seqs" version="@WRAPPER_VERSION@.0">
    <description>Align sequences to a template alignment</description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <expand macro="requirements"/>
    <expand macro="stdio"/>
    <expand macro="version_command"/>
    <command><![CDATA[
@SHELL_OPTIONS@

## enable mothur to find blast
ln -s `dirname \$(which mothur)`/* . &&

## create symlinks to input datasets
ln -s '$fasta' fasta.dat &&
ln -s '$alignment.reference' alignment.reference.dat &&

echo 'align.seqs(
    fasta=fasta.dat,
    reference=alignment.reference.dat,
    align=$align,
    #if $search.method == "kmer":
        ksize=$search.ksize,
    #else:
        search=$search.method,
    #end if
    #if $scoring.adjust == "yes":
        match=$scoring.match,
        mismatch=$scoring.mismatch,
        gapopen=$scoring.gapopen,
        gapextend=$scoring.gapextend,
    #end if
    #if $reverse.flip == "yes":
        flip=true,
        threshold=$reverse.threshold,
    #end if
    processors='\${GALAXY_SLOTS:-8}'
)'
| sed 's/ //g'  ## mothur trips over whitespace
| ./mothur
| tee mothur.out.log
    ]]></command>
    <inputs>
        <param argument="fasta" type="data" format="fasta" label="fasta - Candiate Sequences"/>
        <conditional name="alignment">
            <param name="source" type="select" label="Select Reference Template from" help="">
                <option value="ref">Cached Reference</option>
                <option value="history">Your History</option>
            </param>
            <when value="ref">
                <param argument="reference" type="select" label="reference - Select an alignment database " help="">
                    <options from_data_table="mothur_aligndb"/>
                </param>
            </when>
            <when value="history">
                <param argument="reference" type="data" format="fasta" label="reference - Reference to align with" help=""/>
            </when>
        </conditional>
        <conditional name="search">
            <param name="method" type="select" label="Select a search method" help="">
                <option value="kmer" selected="true">kmer (default)</option>
                <option value="suffix">suffix tree</option>
                <option value="blast">blast</option>
            </param>
            <when value="kmer">
                <param argument="ksize" type="integer" value="8" min="5" max="12" label="ksize - kmer length between 5 and 12"/>
            </when>
            <when value="suffix"/>
            <when value="blast"/>
        </conditional>
        <param argument="align" type="select" label="align - Select a pairwise alignment method">
            <option value="needleman" selected="true">needleman (default)</option>
            <option value="gotoh">gotoh</option>
            <option value="blast">blast</option>
        </param>
        <conditional name="scoring">
            <param name="adjust" type="select" label="Alignment scoring values">
                <option value="no">use defaults</option>
                <option value="yes">adjust values</option>
            </param>
            <when value="yes">
                <param argument="match" type="integer" value="1" label="match - Pairwise alignment reward for a match"/>
                <param argument="mismatch" type="integer" value="-1" label="mismatch - Pairwise alignment penalty for a mismatch"/>
                <param argument="gapopen" type="integer" value="-5" label="gapopen - Pairwise alignment penalty for opening a gap"/>
                <param argument="gapextend" type="integer" value="-2" label="gapextend - Pairwise alignment penalty for extending a gap"/>
            </when>
            <when value="no"/>
        </conditional>
        <conditional name="reverse">
            <param argument="flip" type="select" label="flip - Try to align against the reverse complement" help="">
                <option value="no">No</option>
                <option value="yes">Yes values</option>
            </param>
            <when value="yes">
                <param argument="threshold" type="float" value="0.5" min="0.0" max="1.0"
                    label="threshold - Cutoff (0. - 1.) at which an alignment is deemed 'bad' and the reverse complement may be tried."
                    help="The default for the threshold parameter is 0.50, meaning at least 50% of the bases must remain or the sequence is reported as potentially reversed"/>
            </when>
            <when value="no"/>
        </conditional>
        <expand macro="param-savelog"/>
    </inputs>
    <outputs>
        <expand macro="logfile-output"/>
        <data name="out_align" format="mothur.align" from_work_dir="fasta.align" label="${tool.name} on ${on_string}: align"/>
        <data name="report" format="mothur.align.report" from_work_dir="fasta.align.report" label="${tool.name} on ${on_string}: align.report"/>
        <data name="flip_accnos" format="mothur.accnos" from_work_dir="fasta.flip.accnos" label="${tool.name} on ${on_string}: flip.accnos">
            <filter>reverse['flip'] == 'yes'</filter>
        </data>
    </outputs>
    <tests>
        <test>
            <param name="fasta" value="Mock_S280_L001_R1_001_small.trim.contigs.good.fasta"/>
            <param name="source" value="history"/>
            <param name="reference" value="HMP_MOCK.v35.align"/>
            <output name="out_align" md5="c500a4ae34a16884171f5f9c91f1636b" ftype="mothur.align">
                <assert_contents>
                    <expand macro="test-align-format"/>
                </assert_contents>
            </output>
            <output name="report" file="Mock_S280_L001_R1_001_small.trim.contigs.good.align.report" ftype="mothur.align.report"/>
            <param name="savelog" value="true"/>
            <expand macro="logfile-test"/>
        </test>
        <test>
            <param name="fasta" value="Mock_S280_L001_R1_001_small.trim.contigs.good.fasta"/>
            <param name="source" value="history"/>
            <param name="reference" value="HMP_MOCK.v35.align"/>
            <param name="method" value="kmer"/>
            <param name="adjust" value="yes"/>
            <param name="match" value="2"/>
            <param name="mismatch" value="-15"/>
            <param name="gapopen" value="-6"/>
            <param name="gapextend" value="-3"/>
            <output name="out_align" ftype="mothur.align">
                <assert_contents>
                    <expand macro="test-align-format"/>
                    <has_text text="M00967_43_000000000-A3JHG_1_1101_19936_3208"/>
                </assert_contents>
            </output>
            <output name="report" ftype="mothur.align.report">
                <assert_contents>
                    <expand macro="test-alignreport-format"/>
                    <has_text text="M00967_43_000000000-A3JHG_1_1101_19936_3208"/>
                </assert_contents>
            </output>
            <param name="savelog" value="true"/>
            <expand macro="logfile-test"/>
        </test>
        <test>
            <param name="fasta" value="Mock_S280_L001_R1_001_small.trim.contigs.good.fasta"/>
            <param name="source" value="history"/>
            <param name="reference" value="HMP_MOCK.v35.align"/>
            <param name="method" value="suffix"/>
            <param name="align" value="gotoh"/>
            <param name="adjust" value="yes"/>
            <param name="match" value="2"/>
            <param name="mismatch" value="-15"/>
            <param name="gapopen" value="-6"/>
            <param name="gapextend" value="-3"/>
            <output name="out_align"  ftype="mothur.align">
                <assert_contents>
                    <expand macro="test-align-format"/>
                    <has_text text="M00967_43_000000000-A3JHG_1_1101_19936_3208"/>
                </assert_contents>
            </output>
            <output name="report" ftype="mothur.align.report">
                <assert_contents>
                    <expand macro="test-alignreport-format"/>
                    <has_text text="M00967_43_000000000-A3JHG_1_1101_19936_3208"/>
                </assert_contents>
            </output>
            <param name="savelog" value="true"/>
            <expand macro="logfile-test"/>
        </test>
        <test><!-- test blast -->
            <param name="fasta" value="Mock_S280_L001_R1_001_small.trim.contigs.good.fasta"/>
            <param name="source" value="history"/>
            <param name="reference" value="HMP_MOCK.v35.align"/>
            <param name="method" value="blast"/>
            <param name="align" value="blast"/>
            <param name="flip" value="yes"/>
            <param name="threshold" value="0.5"/>
            <output name="out_align" ftype="mothur.align">
                <assert_contents>
                    <expand macro="test-align-format"/>
                    <has_text text="M00967_43_000000000-A3JHG_1_1101_19936_3208"/>
                </assert_contents>
            </output>
            <output name="report" ftype="mothur.align.report">
                <assert_contents>
                    <expand macro="test-alignreport-format"/>
                    <has_text text="M00967_43_000000000-A3JHG_1_1101_19936_3208"/>
                </assert_contents>
            </output>
            <param name="savelog" value="true"/>
            <expand macro="logfile-test"/>
        </test>
        <test><!-- test accno file recovery with flip set to true -->
            <param name="fasta" value="amazon.fasta"/>
            <param name="source" value="history"/>
            <param name="reference" value="HMP_MOCK.v35.align"/>
            <param name="flip" value="yes"/>
            <param name="threshold" value="0.5"/>
            <output name="out_align" ftype="mothur.align">
                <assert_contents>
                    <expand macro="test-align-format"/>
                    <has_text text="U68621"/>
                </assert_contents>
            </output>
            <output name="report" ftype="mothur.align.report">
                <assert_contents>
                    <expand macro="test-alignreport-format"/>
                    <has_text text="U68621"/>
                </assert_contents>
            </output>
            <output name="flip_accnos" md5="afd8e7629be76baa74451b91423aaa2f" ftype="mothur.accnos">
                <assert_contents>
                    <has_text text="U68621"/>
                    <has_text text="reverse complement"/>
                </assert_contents>
            </output>
            <param name="savelog" value="true"/>
            <expand macro="logfile-test"/>
        </test>
    </tests>
    <help><![CDATA[

@MOTHUR_OVERVIEW@

**Command Documentation**

The align.seqs_ command aligns a user-supplied fasta-formatted fasta sequence file to a user-supplied fasta-formatted template_alignment_.

The general approach is to
 i) find the closest template for each fasta using kmer searching, blastn, or suffix tree searching;
 ii) to make a pairwise alignment between the fasta and de-gapped template sequences using the Needleman-Wunsch, Gotoh,or blastn algorithms; and
 iii) to re-insert gaps to the fasta and template pairwise alignments using the NAST algorithm so that the fasta sequence alignment is compatible with the original template alignment.

In general the alignment is very fast - we are able to align over 186,000 full-length sequences to the SILVA alignment
in less than 3 hrs with a quality as good as the SINA aligner. Furthermore, this rate can be accelerated using multiple
processors. While the aligner doesn't explicitly take into account the secondary structure of the 16S rRNA gene, if the
template database is based on the secondary structure, then the resulting alignment will at least be implicitly based
on the secondary structure.

.. _template_alignment: https://www.mothur.org/wiki/Alignment_database
.. _align.seqs: https://www.mothur.org/wiki/Align.seqs

    ]]></help>
    <expand macro="citations">
         <citation type="doi">10.1093/nar/gkl244</citation>
         <citation type="doi">10.1371/journal.pone.0008230</citation>
         <citation type="doi">10.1371/journal.pcbi.1000844</citation>
    </expand>
</tool>