Object

nl.biopet.tools.vcfstats

VcfStatsSpark

Related Doc: package vcfstats

Permalink

object VcfStatsSpark extends ToolCommand[Args]

This tool can generate metrics from a vcf file. This version of the tool run on Apache Spark

Linear Supertypes
ToolCommand[Args], Logging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. VcfStatsSpark
  2. ToolCommand
  3. Logging
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class ChunkResult(contigFuture: Future[Any], generalStats: Option[RDD[(String, GeneralStats)]], genotypeStats: Option[RDD[(String, GenotypeStats)]], sampleDistributions: Option[RDD[(String, SampleDistributions)]], sampleCompare: Option[RDD[(String, SampleCompare)]], infoFieldCounts: Map[VcfField, RDD[(String, InfoFieldCounts)]], genotypeFieldCounts: Map[VcfField, RDD[(String, GenotypeFieldCounts)]]) extends Product with Serializable

    Permalink

    This is a class to collect results from 1 chunk

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def aboutText: String

    Permalink
    Definition Classes
    ToolCommand
  5. def argsParser: ArgsParser

    Permalink
    Definition Classes
    VcfStatsSpark → ToolCommand
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def cmdArrayToArgs(args: Array[String]): Args

    Permalink
    Definition Classes
    ToolCommand
  9. def contactText: String

    Permalink
    Definition Classes
    ToolCommand
  10. def contigDir(outputDir: File, contig: String): File

    Permalink

    Returns the contig dir of a given contig

  11. def contigGeneralStats(vcfRecords: RDD[VariantContext], cmdArgs: Broadcast[Args], regions: Broadcast[List[BedRecord]], prefixMessage: String): (Option[FutureAction[Unit]], Option[RDD[(String, GeneralStats)]])

    Permalink

    This will generate contigs stats and write this if this is not disabled

  12. def contigGenotypeFieldCounts(vcfRecords: RDD[VariantContext], header: Broadcast[VCFHeader], cmdArgs: Broadcast[Args], regions: Broadcast[List[BedRecord]], prefixMessage: String): Map[VcfField, (Option[Future[Unit]], RDD[(String, GenotypeFieldCounts)])]

    Permalink

    This will generate contigs stats and write this if this is not disabled

  13. def contigGenotypeStats(vcfRecords: RDD[VariantContext], header: Broadcast[VCFHeader], cmdArgs: Broadcast[Args], regions: Broadcast[List[BedRecord]], prefixMessage: String): (Option[FutureAction[Unit]], Option[RDD[(String, GenotypeStats)]])

    Permalink

    This will generate contigs stats and write this if this is not disabled

  14. def contigInfoFieldCounts(vcfRecords: RDD[VariantContext], header: Broadcast[VCFHeader], cmdArgs: Broadcast[Args], regions: Broadcast[List[BedRecord]], prefixMessage: String): Map[VcfField, (Option[Future[Unit]], RDD[(String, InfoFieldCounts)])]

    Permalink

    This will generate contigs stats and write this if this is not disabled

  15. def contigSampleCompare(vcfRecords: RDD[VariantContext], header: Broadcast[VCFHeader], cmdArgs: Broadcast[Args], regions: Broadcast[List[BedRecord]], prefixMessage: String): (Option[FutureAction[Unit]], Option[RDD[(String, SampleCompare)]])

    Permalink

    This will generate contigs stats and write this if this is not disabled

  16. def contigSampleDistributions(vcfRecords: RDD[VariantContext], cmdArgs: Broadcast[Args], regions: Broadcast[List[BedRecord]], prefixMessage: String): (Option[FutureAction[Unit]], Option[RDD[(String, SampleDistributions)]])

    Permalink

    This will generate contigs stats and write this if this is not disabled

  17. def contributingText: String

    Permalink
    Definition Classes
    ToolCommand
  18. def descriptionText: String

    Permalink
    Definition Classes
    VcfStatsSpark → ToolCommand
  19. def documentationText: String

    Permalink
    Definition Classes
    ToolCommand
  20. def emptyArgs: Args

    Permalink
    Definition Classes
    VcfStatsSpark → ToolCommand
  21. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  23. def example(args: String*): String

    Permalink
    Definition Classes
    ToolCommand
  24. def exampleText: String

    Permalink
    Definition Classes
    VcfStatsSpark → ToolCommand
  25. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. def generateDocumentation(outputDirectory: File, version: String, release: Boolean): Unit

    Permalink
    Definition Classes
    ToolCommand
  27. def generateReadme(outputFile: File): Unit

    Permalink
    Definition Classes
    ToolCommand
  28. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  29. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  30. def installationText: String

    Permalink
    Definition Classes
    ToolCommand
  31. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  32. def loadVcfFile(cmdArgs: Broadcast[Args], regions: Broadcast[List[BedRecord]], prefixMessage: String, sorting: Boolean = true, countJob: Boolean = true, cache: Boolean = true)(implicit sc: SparkContext): RDD[VariantContext]

    Permalink

    This method will load a list of regions into memory

  33. def logger: Logger

    Permalink
    Definition Classes
    Logging
  34. def main(args: Array[String]): Unit

    Permalink

    Main entry point from the commandline

    Main entry point from the commandline

    Definition Classes
    VcfStatsSpark → ToolCommand
  35. def mainFromArgs(cmdArgs: Args): Unit

    Permalink

    API entry point

  36. def mainPageContents: List[(String, String)]

    Permalink
    Definition Classes
    ToolCommand
  37. def manualText: String

    Permalink
    Definition Classes
    VcfStatsSpark → ToolCommand
  38. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  39. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  40. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  41. def processContig(regions: Broadcast[List[BedRecord]], cmdArgs: Broadcast[Args], header: Broadcast[VCFHeader], contig: Option[String])(implicit sc: SparkContext): ChunkResult

    Permalink

    This method will execute a list of regions.

  42. def processContigTotal(regions: Broadcast[List[BedRecord]], cmdArgs: Broadcast[Args], header: Broadcast[VCFHeader], contig: Option[String])(implicit sc: SparkContext): (Future[Unit], RDD[(String, StatsTotal)])

    Permalink
  43. def readmeContents: List[(String, String)]

    Permalink
    Definition Classes
    ToolCommand
  44. def sparkExample(args: String*): String

    Permalink
    Definition Classes
    ToolCommand
  45. def sparkUnsafeExample(args: String*): String

    Permalink
    Definition Classes
    ToolCommand
  46. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  47. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  48. def toolName: String

    Permalink
    Definition Classes
    ToolCommand
  49. def totalContigGenotypeFieldCounts(contigs: Map[VcfField, List[RDD[(String, GenotypeFieldCounts)]]], header: Broadcast[VCFHeader], cmdArgs: Broadcast[Args])(implicit sc: SparkContext): Option[Future[Any]]

    Permalink

    This will combine contigs stats and write the output file

  50. def totalContigInfoFieldCounts(contigs: Map[VcfField, List[RDD[(String, InfoFieldCounts)]]], header: Broadcast[VCFHeader], cmdArgs: Broadcast[Args])(implicit sc: SparkContext): Option[Future[Any]]

    Permalink

    This will combine contigs stats and write the output file

  51. def totalGeneralStats(generalContig: List[RDD[(String, GeneralStats)]], cmdArgs: Broadcast[Args])(implicit sc: SparkContext): Option[Future[Unit]]

    Permalink

    This will combine contigs stats and write the output file

  52. def totalGenotypeStats(contigs: List[RDD[(String, GenotypeStats)]], cmdArgs: Broadcast[Args], header: Broadcast[VCFHeader])(implicit sc: SparkContext): Option[Future[Unit]]

    Permalink

    This will combine contigs stats and write the output file

  53. def totalSampleCompare(contigs: List[RDD[(String, SampleCompare)]], cmdArgs: Broadcast[Args], header: Broadcast[VCFHeader])(implicit sc: SparkContext): Option[Future[Unit]]

    Permalink

    This will combine contigs stats and write the output file

  54. def totalSampleDistributions(contigs: List[RDD[(String, SampleDistributions)]], cmdArgs: Broadcast[Args])(implicit sc: SparkContext): Option[Future[Unit]]

    Permalink

    This will combine contigs stats and write the output file

  55. def unsafeExample(args: String*): String

    Permalink
    Definition Classes
    ToolCommand
  56. def urlToolName: String

    Permalink
    Definition Classes
    ToolCommand
  57. def usageHeaders: List[String]

    Permalink
    Attributes
    protected
    Definition Classes
    ToolCommand
  58. def usageHtmlTable: String

    Permalink
    Definition Classes
    ToolCommand
  59. def usageRows(parser: OptionParser[Args]): List[List[String]]

    Permalink
    Attributes
    protected
    Definition Classes
    ToolCommand
  60. def usageText: String

    Permalink
    Definition Classes
    ToolCommand
  61. def validateArgs(args: String*): Unit

    Permalink
    Definition Classes
    ToolCommand
  62. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  64. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ToolCommand[Args]

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped