changeset 3:e9c34ef993d6 draft

Wrote some documentation
author nick
date Wed, 29 May 2013 11:25:22 -0400
parents 3a1ce69571e5
children dfa2e75da6aa
files hetbox.xml
diffstat 1 files changed, 8 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/hetbox.xml	Tue May 28 16:55:39 2013 -0400
+++ b/hetbox.xml	Wed May 29 11:25:22 2013 -0400
@@ -1,8 +1,8 @@
 <tool id="hetbox" version="1.0" name="Minor variant boxplot">
-  <description></description>
+  <description> from allele counts</description>
   <command interpreter="python">hetbox.py $input $outplot $outreport $report</command>
   <inputs>
-    <param name="input" type="data" format="tabular" label="Input allele counts file"/>
+    <param name="input" type="data" format="tabular" label="Input allele counts"/>
     <param name="report" type="boolean" truevalue="-r" falsevalue="" checked="False" label="Also produce a text report" />
   </inputs>
   <outputs>
@@ -12,6 +12,12 @@
 
   <help>
 
+.. class:: infomark
+
+**What it does**
+
+    This will create a boxplot from the output of the "Count alleles" tool, showing the number of minor alleles per sample and the distribution of their frequencies (MAF). It can also, optionally, produce a textual report with these numbers.
+
   </help>
 
   <requirements>