annotate regionFitness.xml @ 5:48c8d3ed441a draft

Uploaded

<tool id="regionFitness" name="Region Fitness" version="0.1.0">

<!-- Margaret Antonio  17.01.08 -->

    <requirements>
	<!--<requirement type="set_environment">LINKYX_PATH</requirement>-->
        <requirement type="package" version="5.18.1">perl</requirement>
        <requirement type="package" version="0.25">perl_list_binarysearch</requirement>
        <requirement type="package" version="2.45">perl_getopt_long</requirement>
        <requirement type="package" version="0.12">perl_data_random</requirement>
        <requirement type="package" version="1.6.922">bioperl</requirement>
    </requirements>

    <description>assess fitness effect of mutations in a region (sliding window or custom)</description>
    
    <command interpreter="perl">
        regionFitness.pl
        -f $fasta
        -r $ref_genome
        -c $cutoff
        -n $run
        -m $max
        #if $region.define == "c":
            -u $region.custom
        #end if
        #if $region.define == "s":
            -size $region.size
            -step $region.step
        #end if
        #if $weight.algorithm == "yes":
            -w
            -wc $weight.ceiling
        #end if
        
        -f1 $allTAsites
        -f2 $nullDist
        -f3 $slidingWindows
        -f4 $fitWindowscsv
        -f5 $fitWindowswig
        -f6 $fitWindowstxt
        
        $input
        #for $a in $additionalcsv
            ${a.input2}
        #end for
        
    </command>
    
    <inputs>
        <param name="input" type="data" label="CSV Fitness File(s)"/>
        <repeat name="additionalcsv" title="Additional csv fitness file(s)">
            <param name="input2" type="data" label="Select" />
        </repeat>
        <param format="fasta" name="fasta" type="data" label="Fasta file"/>
        <param name="ref_genome" type="data" label="GenBank reference genome"/>
        
        <conditional name="region">
            <param name="define" type="select" label="Define regions: custom or sliding?">
                <option value="s">Sliding Windows</option>
                <option value="c">Custom</option>
            </param>
            <when value="s">
                <param name="size" type="integer" value="500" label="Sliding window size"/>
                <param name="step" type="integer" value="10" label="Sliding window intervals"/>
            </when>
            <when value="c">
                <param name="custom" type="data" label="File with custom regions" />
            </when>
        </conditional>
        
        <conditional name="weight">
            <param name="algorithm" type="select" label="Use weighted algorithms?">
                <option value="yes">Yes</option>
                <option value="no">No</option>
            </param>
            <when value = "yes">
                <param name="ceiling" type="integer" value="50" label="Weight ceiling"/>
            </when>
        </conditional>

        <param name="cutoff" type="integer" value="10" label="Cutoff"/>
        <param name="max" type="integer" value="100" label="Highest # insertions in region"/>
        <param name="run" type="text" value="run1" label="Name of run (will be appended to output files)"/>

    </inputs>
    
    <outputs>
        <data format="txt" name="allTAsites" label="${run}_allTAsites" />
        <data format="txt" name="unmatched" label="${run}_unmatched"/>
        <data format="txt" name="nullDist" label="${run}_nullDist"/>
        <data format="csv" name="slidingWindows" label="${run}_slidingWindows"/>
        <data format="csv" name="fitWindowscsv" label="${run}_fitWindows_csv"/>
        <data format="wig" name="fitWindowswig" label="${run}_fitWindows_wig"/>
        <data format="txt" name="fitWindowstxt" label="${run}_fitWindows_txt"/>
    </outputs>
    
    <help>
        **Tool Description**
        
        This tool takes a non-gene-centric approach to assessing importance of regions (user defined or sliding windows) to organismal fitness.
        
        **Options**
        
        *The csv fitness file(s)*: These are the csv (comma separated values) files containing the fitness values that will be used in downstream analyses. Since they should have been produced by the "Calculate Fitness" tool, each line besides the header should represent the following information for an insertion location: position,strand,count_1,count_2,ratio,mt_freq_t1,mt_freq_t2,pop_freq_t1,pop_freq_t2,gene,D,W,nW
        
        *Fasta file*: the fasta file for the genome of the organism
        
        *GenBank reference genome*: the reference genome of whatever model you're working with, which needs to be in standard genbank format. For more on that format see the genbank website.
        
        *Region definition*: Define the regions by a custom file or by sliding windows at a set size and step. If using the custom region option, provide a tab-delimited file with start and end coordinates of each region, one region per line. If choosing the sliding window option, specify the size of the window over which assessments will be made and the step, how much the sliding window increments at each asssessment.
        
        *Max*: The maximum number of insertions expected in a window. This is used for creating a null distrubtion upon which the significance of regional essentiality is assessed. An error will be produced if the maximum number of insertions is lower than the actual. Run the Data Overview tool to find the real max number of insertions in a window. This option will be removed later by being data-determined.
        
        *Weight ceiling*: This value lets you set a weight ceiling for the weights of fitness values. It's only relevant if you're using weighted algorithms.
        
        *Cutoff*: This value lets you ignore the fitness scores of any insertion locations with an average count (the number of counts from t1 and t2 divided by 2) less than it.
        
        *Run name*: The name of the run, to be appended to the end of every output file.
        
        
    </help>
    
</tool>