view galaxy-conf/ZScore.xml @ 12:81d5b81fb3c2 draft

Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
author timpalpant
date Wed, 25 Apr 2012 16:53:48 -0400
parents 9266d807ca85
children eb53be9a09f4
line wrap: on
line source

<tool id="WigZScore" name="Z-Score" version="1.0.0">
  <description>a (Big)Wig file</description>
  <command interpreter="sh">galaxyToolRunner.sh wigmath.ZScore -i $input -o $output</command>
  <inputs>
      <param format="bigwig,wig" name="input" type="data" label="Z-score the data in" />
  </inputs>
  <outputs>
      <data format="wig" name="output" metadata_source="input" />
  </outputs>
  <tests>
    <!--<test>
	    <param name="input" value="wigmath.input1"/>
	    <param name="dbkey" value="sacCer2"/>
	    <output name="output" file="zscorer.output1"/>
	  </test>
	  <test>
	    <param name="input" value="wigmath.input1.bw"/>
	    <param name="dbkey" value="sacCer2"/>
	    <output name="output" file="zscorer.output1"/>
	  </test>
	  <test>
	    <param name="input" value="wigmath.input2"/>
	    <param name="dbkey" value="sacCer2"/>
	    <output name="output" file="zscorer.output2"/>
	  </test>
	  <test>
	    <param name="input" value="wigmath.input2.bw"/>
	    <param name="dbkey" value="sacCer2"/>
	    <output name="output" file="zscorer.output2"/>
	  </test>
	  <test>
	    <param name="input" value="wigmath.input3"/>
	    <param name="dbkey" value="sacCer2"/>
	    <output name="output" file="zscorer.output3"/>
	  </test>
	  <test>
	    <param name="input" value="wigmath.input3.bw"/>
	    <param name="dbkey" value="sacCer2"/>
	    <output name="output" file="zscorer.output3"/>
	  </test>-->
  </tests>
  
  <help>

This tool will compute normal scores (Z-scores) for each of the values in a Wig file. For each base pair, the Z-scored value is equal to the deviance from the mean divided by the standard deviation (i.e. the number of standard deviations a value is away from the mean). The output file should have mean 0 and standard deviation 1.

.. class:: infomark

This tool is equivalent to using the **Mean Shift** tool to shift a Wig file to mean 0, then using the **Scale** tool to scale by 1/(standard deviation).

.. class:: infomark

**TIP:** If your dataset does not appear in the pulldown menu, it means that it is not in Wig or BigWig format. Use "edit attributes" to set the correct format if it was not detected correctly.

  </help>
</tool>