Package picard.analysis

Class CollectQualityYieldMetricsFlow

java.lang.Object
picard.cmdline.CommandLineProgram
picard.analysis.SinglePassSamProgram
picard.analysis.CollectQualityYieldMetricsFlow
@ExperimentalFeature public class CollectQualityYieldMetricsFlow extends SinglePassSamProgram
Command line program to calculate quality yield metrics for flow based read files

  • Field Details

    • qualityHistogram

      public htsjdk.samtools.util.Histogram<Integer> qualityHistogram

    • INCLUDE_SECONDARY_ALIGNMENTS

      @Argument(doc="If true, include bases from secondary alignments in metrics. Setting to true may cause double-counting of bases if there are secondary alignments in the input file.") public boolean INCLUDE_SECONDARY_ALIGNMENTS

    • INCLUDE_SUPPLEMENTAL_ALIGNMENTS

      @Argument(doc="If true, include bases from supplemental alignments in metrics. Setting to true may cause double-counting of bases if there are supplemental alignments in the input file.") public boolean INCLUDE_SUPPLEMENTAL_ALIGNMENTS

    • INCLUDE_BQ_HISTOGRAM

      @Argument(doc="Determines whether to include the flow quality histogram in the metrics file.") public boolean INCLUDE_BQ_HISTOGRAM

    • fbargs

      @ArgumentCollection(doc="flow based args") public FlowBasedArgumentCollection fbargs

  • Constructor Details

    • CollectQualityYieldMetricsFlow

      public CollectQualityYieldMetricsFlow()

  • Method Details

    • usesNoRefReads

      protected boolean usesNoRefReads()
      Ensure that we get all reads regardless of alignment status.
      Overrides:
      usesNoRefReads in class SinglePassSamProgram

    • setup

      protected void setup(htsjdk.samtools.SAMFileHeader header, File samFile)
      Description copied from class: SinglePassSamProgram
      Should be implemented by subclasses to do one-time initialization work.
      Specified by:
      setup in class SinglePassSamProgram

    • acceptRead

      protected void acceptRead(htsjdk.samtools.SAMRecord rec, htsjdk.samtools.reference.ReferenceSequence ref)
      Description copied from class: SinglePassSamProgram
      Should be implemented by subclasses to accept SAMRecords one at a time. If the read has a reference sequence and a reference sequence file was supplied to the program it will be passed as 'ref'. Otherwise 'ref' may be null.
      Specified by:
      acceptRead in class SinglePassSamProgram

    • finish

      protected void finish()
      Description copied from class: SinglePassSamProgram
      Should be implemented by subclasses to do one-time finalization work.
      Specified by:
      finish in class SinglePassSamProgram