Adding warning on HardClipping

Hard Clipping is still under heavy development and should not be used by anyone less prepared than MacGyver.
2011-09-23 19:00:19 -04:00 · 2011-09-23 19:00:19 -04:00 · fbe3c1e0b3
parent e1cb5f6459
commit fbe3c1e0b3
1 changed files with 2 additions and 0 deletions
--- a/public/java/src/org/broadinstitute/sting/utils/clipreads/ClippingRepresentation.java
+++ b/public/java/src/org/broadinstitute/sting/utils/clipreads/ClippingRepresentation.java
@ -21,6 +21,8 @@ public enum ClippingRepresentation {
    SOFTCLIP_BASES,

    /**
+     * WARNING: THIS OPTION IS STILL UNDER DEVELOPMENT AND IS NOT SUPPORTED.
+     *
     * Change the read's cigar string to hard clip (H, see sam-spec) away the bases.
     * Hard clipping, unlike soft clipping, actually removes bases from the read,
     * reducing the resulting file's size but introducing an irrevesible (i.e.,