diff --git a/java/src/org/broadinstitute/sting/alignment/AlignmentValidationWalker.java b/java/src/org/broadinstitute/sting/alignment/AlignmentValidationWalker.java index 116803ed6..646d055d6 100644 --- a/java/src/org/broadinstitute/sting/alignment/AlignmentValidationWalker.java +++ b/java/src/org/broadinstitute/sting/alignment/AlignmentValidationWalker.java @@ -12,7 +12,9 @@ import net.sf.samtools.SAMRecord; import java.util.Iterator; /** - * Validates alignments against existing reads. + * Validates consistency of the aligner interface by taking reads already aligned by BWA in a BAM file, stripping them + * of their alignment data, realigning them, and making sure one of the best resulting realignments matches the original + * alignment from the input file. * * @author mhanna * @version 0.1 diff --git a/java/src/org/broadinstitute/sting/alignment/AlignmentWalker.java b/java/src/org/broadinstitute/sting/alignment/AlignmentWalker.java index 8fb2f5061..ee22a2e20 100644 --- a/java/src/org/broadinstitute/sting/alignment/AlignmentWalker.java +++ b/java/src/org/broadinstitute/sting/alignment/AlignmentWalker.java @@ -12,7 +12,8 @@ import net.sf.picard.reference.ReferenceSequenceFileFactory; import java.io.File; /** - * Align reads to the reference specified by BWTPrefix. + * Aligns reads to a given reference using Heng Li's BWA aligner, presenting the resulting alignments in SAM or BAM format. + * Mimics the steps 'bwa aln' followed by 'bwa samse' using the BWA/C implementation. * * @author mhanna * @version 0.1 diff --git a/java/src/org/broadinstitute/sting/alignment/CountBestAlignmentsWalker.java b/java/src/org/broadinstitute/sting/alignment/CountBestAlignmentsWalker.java index 30d892d71..fd87e710e 100644 --- a/java/src/org/broadinstitute/sting/alignment/CountBestAlignmentsWalker.java +++ b/java/src/org/broadinstitute/sting/alignment/CountBestAlignmentsWalker.java @@ -10,7 +10,8 @@ import net.sf.samtools.SAMRecord; import java.util.*; /** - * Counts the number of best alignments + * Counts the number of best alignments as presented by BWA and outputs a histogram of number of placements vs. the + * frequency of that number of placements. * * @author mhanna * @version 0.1 diff --git a/java/src/org/broadinstitute/sting/alignment/package-info.java b/java/src/org/broadinstitute/sting/alignment/package-info.java new file mode 100644 index 000000000..60cf1e425 --- /dev/null +++ b/java/src/org/broadinstitute/sting/alignment/package-info.java @@ -0,0 +1,4 @@ +/** + * Analyses used to validate the correctness and performance the BWA Java bindings. + */ +package org.broadinstitute.sting.alignment; \ No newline at end of file