annotate leftalign.xml @ 28:977a5301b66d draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 9bbda385129b4bc34f66889d28c2570bf5bb2214

<?xml version="1.0"?>
<tool id="bamleftalign" name="BamLeftAlign" version="@DEPENDENCY_VERSION@-2">
    <description> indels in BAM datasets</description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <expand macro="requirements" />
    <command detect_errors="exit_code"><![CDATA[
        ##set up input files
        #set $reference_fasta_filename = "localref.fa"
        #if str( $reference_source.reference_source_selector ) == "history":
            ln -s '${reference_source.ref_file}' '${reference_fasta_filename}' &&
            samtools faidx "${reference_fasta_filename}" 2>&1 || echo "Error running samtools faidx for leftalign" >&2 &&
        #else:
            #set $reference_fasta_filename = str( $reference_source.ref_file.fields.path )
        #end if

        ##start leftalign commandline
        cat '${input_bam}' |
        bamleftalign
            --fasta-reference '${reference_fasta_filename}'
            -c
            --max-iterations "${iterations}"
            > '${output_bam}'
    ]]></command>
    <inputs>
        <conditional name="reference_source">
            <param name="reference_source_selector" type="select" label="Choose the source for the reference genome">
                <option value="cached">Locally cached</option>
                <option value="history">History</option>
            </param>
            <when value="cached">
                <param name="input_bam" type="data" format="bam" label="Select alignment file in BAM format">
                    <validator type="unspecified_build" />
                    <validator type="dataset_metadata_in_data_table" table_name="fasta_indexes" metadata_name="dbkey"
                               metadata_column="1" message="Sequences are not currently available for the specified build." />
                </param>
                <param name="ref_file" type="select" label="Using reference genome" argument="--fasta-reference">
                    <options from_data_table="fasta_indexes"></options>
                    <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
                </param>
            </when>
            <when value="history"> 
                <param name="input_bam" type="data" format="bam" label="BAM dataset to re-align" />
                <param name="ref_file" type="data" format="fasta" label="Using reference file" argument="--fasta-reference" />
            </when>
        </conditional>
        <param name="iterations" type="integer" value="5" label="Maximum number of iterations"
               help="Iterate the left-realignment no more than this many times" argument="--max-iterations" />
    </inputs>
    <outputs>
        <data format="bam" name="output_bam" label="${tool.name} on ${on_string} (alignments)" />
    </outputs>
    <tests>
        <test>
            <param name="reference_source_selector" value="history" />
            <param name="ref_file" ftype="fasta" value="leftalign.fa"/>
            <param name="input_bam" ftype="bam" value="left-align-input.bam"/>
            <param name="iterations" value="5"/>
            <output name="output_bam" file="left-align-output.bam" />
        </test>
    </tests>
    <help>

When calling indels, it is important to homogenize the positional distribution of insertions and deletions in the input by using left realignment. Left realignment will place all indels in homopolymer and microsatellite repeats at the same position, provided that doing so does not introduce mismatches between the read and reference other than the indel. This method is computationally inexpensive and handles the most common classes of alignment inconsistency.

This is leftalign utility from FreeBayes package.
    </help>
    <expand macro="citations" />
</tool>