Add readme to utils folder

mikessh · Apr 8, 2016 · 0b94de7 · 0b94de7
1 parent 6ffc2ac
commit 0b94de7
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/util/README.md b/util/README.md
@@ -0,0 +1,9 @@
+## Various utilities
+
+This folder contains a number of scripts for processing MIGEC output:
+
+* ``GroomConsensusFastq.groovy input.fastq[.gz] output.fastq[.gz]`` will ensure compatibility of assembled consensus FASTQ file by grooming headers and correcting read orientation (use ``-r`` flag for second read FASTQ for this purpose).
+
+* ``histogram.R`` and ``pwm.R`` are scripts to produce some fancy graphics for ``Histogram`` routine output.
+
+* ``migec_summary.Rmd`` is the MIGEC summary template (same as the one used by ``Report`` routine).