Trait

nl.biopet.utils.tool

ToolCommand

Related Doc: package tool

Permalink

trait ToolCommand[Args] extends Logging

Trait for biopet tools, sets some default args, adds documentation generator

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

Abstract Value Members

  1. abstract def argsParser: AbstractOptParser[Args]

    Permalink

    This is the parser object that will be tested.

  2. abstract def descriptionText: String

    Permalink

    Force description to be written for each tool.

  3. abstract def emptyArgs: Args

    Permalink

    Returns an empty/default args case class

  4. abstract def exampleText: String

    Permalink

    Force an example to be written for each tool

  5. abstract def main(args: Array[String]): Unit

    Permalink

    This is the main entry point of the tool

  6. abstract def manualText: String

    Permalink

    Force a manual to be written for each tool

Concrete 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

    Universal text referring to BIOPET.

  5. final def asInstanceOf[T0]: T0

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

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

    Permalink

    Converts args to a Args case class

  8. def contactText: String

    Permalink

    Universal contact text

  9. def contributingText: String

    Permalink

    Universal contributing text

  10. def documentationText: String

    Permalink

    Universal text for pointing to the documentation.

  11. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink

    Convert and tests args

  14. def finalize(): Unit

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

    Permalink

    Outputs markdown documentation for LAIKA processing.

    Outputs markdown documentation for LAIKA processing.

    outputDirectory

    outputs the Markdown documentation in this directory

  16. def generateReadme(outputFile: File): Unit

    Permalink

    Generates the README

    Generates the README

    outputFile

    The readme file

  17. final def getClass(): Class[_]

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

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

    Permalink

    Universal installation text

  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. def logger: Logger

    Permalink
    Definition Classes
    Logging
  22. def mainPageContents: List[(String, String)]

    Permalink

    Which chapters should be on the tool documentation's main page

  23. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  26. def readmeContents: List[(String, String)]

    Permalink

    Which chapters should be in the README

  27. def sparkExample(args: String*): String

    Permalink

    Convert and tests args

  28. def sparkUnsafeExample(args: String*): String

    Permalink

    Convert and *not* tests args

  29. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

    Permalink

    This will return the name of the tool

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

    Permalink

    Convert and *not* tests args

  33. def urlToolName: String

    Permalink

    This is the tool name to be used in URL.

    This is the tool name to be used in URL. Can be overwritten.

  34. def usageText: String

    Permalink

    Creates a html formatted usage string

  35. final def wait(): Unit

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

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

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

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped