annotate runAssembly.xml @ 3:bf1f8bc4abe6 default tip

minor updates for v2.6

<tool id="runAssembly" name="runAssembly" version="1.0.1" force_history_refresh="True">
<description>De novo assembly of Roche/454 reads using Newbler</description>
<command interpreter="perl">runAssembly_wrapper.pl
$newbler_metrics.extra_files_path
$newbler_metrics
$read_status
$trimmed_reads_fasta
$trimmed_reads_qual
$alignment_info
$all_contigs_fasta
$all_contigs_qual
$contigs_ace
$contigs_consed_ace
$contig_graph
$pair_align
$pair_status
$scaffolds_fasta
$scaffolds_qual
$scaffolds_agp
$contig_scaffolds_agp
$tag_pair_align
$trim_status
$large_contigs_fasta
$large_contigs_qual
runAssembly
-o $newbler_metrics.extra_files_path
-cpu 8 
$rip 
-e $e 
-mi $mi 
-ml $ml 
-minlen $minlen 
$large 
$pair 
$info 
$notrim 
$tr 
$ace 
$no 
$qo 
$nor 
$ud 
-ss $ss 
-sl $sl 
-sc $sc 
-ais $ais 
-a $a
-mcf $mcf
-vs $vs
-vt $vt
-fi $fi
-fe $fe
-l $l 
#for $i in $sff_paired_inputs
-p ${i.sff_paired_input}
#end for
#for $i in $sanger_paired_inputs
-p ${i.sanger_paired_input}
#end for
#for $i in $sff_inputs
${i.sff_input}
#end for
#for $i in $sanger_inputs
${i.sanger_input}
#end for
</command>
<inputs>
    <!-- READSEQ INFILES -->
    <repeat name="sff_inputs" title="Unpaired Reads Sff Files">
        <param name="sff_input" type="data" format="sff" label="SE Sff file"/>
    </repeat>
    <repeat name="sanger_inputs" title="Unpaired Reads Fasta/Fastq Files">
        <param name="sanger_input" type="data" format="fasta,fastqsanger" label="SE Fasta/Fastq file"/>
    </repeat>
    <repeat name="sff_paired_inputs" title="Paired Reads Sff Files">
        <param name="sff_paired_input" type="data" format="sff" label="PE Sff file"/>
    </repeat>
    <repeat name="sanger_paired_inputs" title="Paired Reads Fasta/Fastq Files">
        <param name="sanger_paired_input" type="data" format="fasta,fastqsanger" label="PE Fasta/Fastq file"/>
    </repeat>
    <param name="paired_reads" type="select" display="radio" label="[-paired_reads] If supplying paired reads (above), do you want paired-read info?">
        <option value="false">no</option>
        <option value="true">[-paired_reads] yes</option>
    </param>
    <param name="pair" type="select" display="radio" label="[-pair] Output pairwise overlaps">
        <option value="">no</option>
        <option value="-pair">[-pair] yes</option>
    </param>
    
    <param name="l" type="integer" value="500" label="[-l] This option sets the minimum length for a contig to appear in the 454LargeContigs.fna file"/>

   <!-- OPTIONAL ARGUMENTS -->
    <param name="mcf" type="data" format="tabular" optional="true" label="[-mcf] Specify non-default MID config file" />
    <param name="fi" type="data" format="txt" optional="true" label="[-fi] Include filter file to be specified" />
    <param name="fe" type="data" format="txt" optional="true" label="[-fe] Exclude filter file to be specified" />
    <param name="vt" type="data" format="fasta" optional="true" label="[-vt] This option specifies a vector trimming database, or FASTA file of sequences to be used to trim the ends of input reads (for cloning vectors, primers, adapters or other end sequences)" />
    <param name="vs" type="data" format="fasta" optional="true" label="[-vs] This option specifies a vector screening database, or FASTA file of sequences to be used to screen the input reads for contaminants.  Reads that completely align against the screening database are trimmed completely (so that it is not used in the computation), but otherwise the read trimpoints are not changed" />
        
    <!-- READ TRIMMING -->
    <param name="minlen" type="integer" value="20" label="[-minlen] Minimum length of reads to use (15-45 allowed)"/>
    <param name="notrim" type="boolean" truevalue="-notrim" falsevalue="" checked="false" label="[-notrim] Do not perform default quality and primer trimming of input reads"/>
    <param name="tr" type="select" display="radio" label="[-tr] Output trimmed reads">
        <option value="">no</option>
        <option value="-tr">[-tr] yes</option>
    </param>
    <param name="nor" type="boolean" truevalue="-nor" falsevalue="" label="[-nor] Turn off the automatic rescore function for read quality scores"/>
    <param name="ud" type="boolean" truevalue="-ud" falsevalue="" label="[-ud] Treat each read separately, with no grouping of duplicates"/>

    <!-- ALIGNMENT PARAMETERS -->
    <param name="ss" type="integer" value="12" label="[-ss] Seed step parameter - The number of bases between seed generation locations used in the exact k-mer matching part of the overlap detection. Allow values: 1 or greater"/>
    <param name="sl" type="integer" value="16" label="[-sl] Seed length parameter - The number of bases used for each seed in the exact k-mer matching part of the overlap detection (i.e. the 'k' value of the k-mer matching). Allowed values: 6-16"/>
    <param name="sc" type="integer" value="1" label="[-sc] Seed count parameter - The number of seeds required in a window before an extension is made. Allowed values: 1 or greater"/>
    <param name="ml" type="text" value="40" label="[-ml] Minimum overlap length - The minimum length of overlaps used for the pairwise alignment step. The value can either be a minimum length in bases or a percentage of read length. In the case of a percentage, simply include '%' immediately following the numeric value. Allowed values: 1 or greater"/>
    <param name="mi" type="integer" value="90" label="[-mi] Minimum overlap identity - The percent identity of overlaps used for the pairwise alignment step. Allowed values: 0 or greater"/>
    <param name="ais" type="integer" value="2" label="[-ais] Alignment identity score - When multiple overlaps are found, the per-overlap column identity score used to sort the overlaps for use in the progressive alignment. Allowed values: 0 or greater"/>

    <!-- ASSEMBLY OPTIONS -->
    <param name="e" type="integer" value="0" label="[-e] This option tells the assembler that the expected depth of the data is at a certain level.  The assembler has been optimized for datasets in the 10-50x oversampling size, and this option helps the assembler with datasets that have a higher oversampling level.  A value of 0 resets the assembler computation to use its default algorithms"/>
    <param name="large" type="boolean" truevalue="-large" falsevalue="" checked="false" label="[-large] Check if large or complex genome"/>
    <param name="scaffold" type="boolean" truevalue="-scaffold" falsevalue="" checked="true" label="[-scaffold] Output scaffolds"
        help="Select this option to output scaffoldContigs to Fasta and Qual files. When selected, the contents of 454Scaffolds.txt will represent scaffoldContigs and gaps rather than the contigs found in the allContigs file. An additional file, 454ContigScaffolds.txt, will be produced that is identical to the 454Scaffolds.txt file produced without this option. The scaffoldContig names found in the 454Scaffolds.txt file represent the scaffoldContigs found in the 454ScaffoldContigs Fasta and Qual files." />

    <!-- OUTPUT OPTIONS -->
    <param name="no" type="select" display="radio" label="[-no] Do complete assembly">
        <option value="">do complete assembly</option>
        <option value="-no">[-no] do not assemble; do alignments only</option>
    </param>
    <param name="qo" type="boolean" truevalue="" falsevalue="-qo" checked="false" label="[-qo] Generate quick output for mapping and assembly. Disables signal distribution computation for calling consensus sequences and can decrease accuracy"/>
    <param name="a" type="integer" value="100" label="[-a] This option sets the minimum length for a contig to appear in the 454AllContigs.fna file."/>
    <param name="rip" type="boolean" truevalue="" falsevalue="-rip" checked="false" label="[-rip] Output each read in only one contig"/>
    <param name="info" type="select" display="radio" label="Output Alignment Info">
        <option value="-info">[-info] yes</option>
        <option value="-infoall">[-infoall] yes, including 0-coverage positions</option>
    </param>
    <param name="ace" type="select" display="radio" label="Produce Ace assembly file">
        <option value="">no</option>
        <option value="-ace">[-ace] yes</option>
        <option value="-ace -consed">[-consed] yes, in consed dir</option>
    </param>
</inputs>

<outputs>
    <data name="newbler_metrics" format="txt" />
    <data name="read_status" format="tabular" label="${tool.name} on $on_string: Read Status"/>
    <data name="trimmed_reads_fasta" format="fasta" label="${tool.name} on $on_string: Trimmed Reads (Fasta)">
        <filter>tr == "-tr"</filter>
    </data>
    <data name="trimmed_reads_qual" format="qual454" label="${tool.name} on $on_string: Trimmed Reads (Qual)">
        <filter>tr == "-tr"</filter>
    </data>
    <!-- the following produced only if no != "-no" -->
    <data name="alignment_info" format="tabular" label="${tool.name} on $on_string: Alignment Info">
        <filter>no != "-no"</filter>
    </data>
    <data name="all_contigs_fasta" format="fasta" label="${tool.name} on $on_string: All Contigs (Fasta)">
        <filter>no != "-no"</filter>
    </data>
    <data name="all_contigs_qual" format="qual454" label="${tool.name} on $on_string: All Contigs (Qual454)">
        <filter>no != "-no"</filter>
    </data>
    <data name="contigs_ace" format="ace" label="${tool.name} on $on_string: Contigs (Ace)">
        <filter>ace == "-ace" and no != "-no"</filter>
    </data>
    <data name="contigs_consed_ace" format="ace" label="${tool.name} on $on_string: Contigs (Consed/Ace)">
        <filter>ace == "-ace -consed" and no != "-no"</filter>
    </data>

    <data name="contig_graph" format="txt" label="${tool.name} on $on_string: Contig Graph"/>
    <data name="large_contigs_fasta" format="fasta" label="${tool.name} on $on_string: Large Contigs (Fasta)">
        <filter>no != "-no"</filter>
    </data>
    <data name="large_contigs_qual" format="qual454" label="${tool.name} on $on_string: Large Contigs (Qual454)">
        <filter>no != "-no"</filter>
    </data>
    <data name="pair_align" format="txt" label="${tool.name} on $on_string: Pairwise Alignments">
        <filter>pair == "-pair" and no != "-no"</filter>
    </data>
    <data name="pair_status" format="tabular" label="${tool.name} on $on_string: Paired-End Read Status">
        <filter>paired_reads == "true" and no != "-no"</filter>
    </data>
    <data name="scaffolds_fasta" format="fasta" label="${tool.name} on $on_string: Scaffolds (Fasta)">
        <filter>paired_reads == "true" and no != "-no"</filter>
    </data>
    <data name="scaffolds_qual" format="qual454" label="${tool.name} on $on_string: Scaffolds (Qual454)">
        <filter>paired_reads == "true" and no != "-no"</filter>
    </data>
    <data name="scaffolds_agp" format="tabular" label="${tool.name} on $on_string: Scaffolds (Agp)">
        <filter>paired_reads == "true" and no != "-no"</filter>
    </data>
    <data name="contig_scaffolds_agp" format="tabular" label="${tool.name} on $on_string: Contig Scaffolds(Agp)">
        <filter>scaffold is True</filter>
    </data>
    <data name="tag_pair_align" format="txt" label="${tool.name} on $on_string: Tag Pair Alignments">
        <filter>pair == "-pair" and paired_reads == "true" and no != "-no"</filter>
    </data>
    <data name="trim_status" format="tabular" label="${tool.name} on $on_string: Trim Status"/>

</outputs>
<help>

**What it does**

Assemble (Roche/454) reads using Newbler.

Download the manual here: http://galaxy.jgi-psf.org/static/manuals/GSFLXSystemSoftwareManual_PartC_Assembler-Mapper-SFFTools.pdf

.. class:: warningmark

**Fasta Header Format** Fasta input must provide any pairing information in the header using the expected key=value format.  Use the 'Sanger tab to Newbler Fasta' tool.

</help>
</tool>