Commit a087ca24 authored by Sander van der Zeeuw's avatar Sander van der Zeeuw
Browse files

Typos and reformulating sentences

parent a3907a6f
# Introduction # Introduction
Within the LUMC we have a compute cluster which runs on the Sun Grid Engine (SGE). The cluster has around 600 cores now and multiple terabytes of memory. Within the LUMC we have a compute cluster which runs on the Sun Grid Engine (SGE). This cluster currently consists of around 600
The SGE enables the cluster to schedule all the jobs coming from different users in a fair way. So Resources are shared equally between multiple users. cores and several terabytes of memory. The Sun Grid Engine (SGE) enables the cluster to schedule all the jobs coming from
different users in a fair way. So Resources are shared equally between multiple users.
# Sun Grid Engine # Sun Grid Engine
......
# Developer - Code style # Developer - Code style
## General rules ## General rules
- Variable names should always be in *CamelCase* and does **not** start with a capital letter - Variable names should always be in *camelCase* and does **not** start with a capital letter
```scala ```scala
// correct: // correct:
...@@ -11,7 +11,7 @@ val outputFromProgram: String = "foobar" ...@@ -11,7 +11,7 @@ val outputFromProgram: String = "foobar"
val OutputFromProgram: String = "foobar" val OutputFromProgram: String = "foobar"
``` ```
- Class names should always be in *CamelCase* and does **always** start with a capital letter - Class names should always be in *CamelCase* and **always** start with a capital letter
```scala ```scala
// correct: // correct:
......
...@@ -43,9 +43,10 @@ import nl.lumc.sasc.biopet.utils.config.Configurable ...@@ -43,9 +43,10 @@ import nl.lumc.sasc.biopet.utils.config.Configurable
import nl.lumc.sasc.biopet.extensions.{ Gzip, Cat } import nl.lumc.sasc.biopet.extensions.{ Gzip, Cat }
import org.broadinstitute.gatk.queue.QScript import org.broadinstitute.gatk.queue.QScript
//TODO: Replace class name, must be the same as the class of the pipeline //TODO: Replace class name, must be the same as the name of the pipeline
class SimplePipeline(val root: Configurable) extends QScript with BiopetQScript { class SimplePipeline(val root: Configurable) extends QScript with BiopetQScript {
// A constructor without arguments is needed if this pipeline is a root pipeline // A constructor without arguments is needed if this pipeline is a root pipeline
// Root pipeline = the pipeline one wants to start on the commandline
def this() = this(null) def this() = this(null)
@Input(required = true) @Input(required = true)
...@@ -69,7 +70,7 @@ class SimplePipeline(val root: Configurable) extends QScript with BiopetQScript ...@@ -69,7 +70,7 @@ class SimplePipeline(val root: Configurable) extends QScript with BiopetQScript
} }
} }
//TODO: Replace object name, must be the same as the class of the pipeline
object SimplePipeline extends PipelineCommand object SimplePipeline extends PipelineCommand
``` ```
......
...@@ -57,10 +57,15 @@ Note that there is a tool called [SamplesTsvToJson](../tools/SamplesTsvToJson.md ...@@ -57,10 +57,15 @@ Note that there is a tool called [SamplesTsvToJson](../tools/SamplesTsvToJson.md
### The settings config ### The settings config
The settings config enables a user to alter the settings for almost all settings available in the tools used for a given pipeline. The settings config enables a user to alter the settings for almost all settings available in the tools used for a given pipeline.
This config file should be written in JSON format. This config file should be written in either JSON or YAML format. It can contain setup settings like:
It can contain setup settings like references, cut offs, program modes, memory limits (program specific), if chunking should be used and many more, one can even set program executables here, if for some reason the user does not want to use the systems default tools. * references,
One could set global variables containing settings for all tools used in the pipeline or set tool specific options one layer deeper into the JSON file. * cut offs,
E.g. in the example below the settings for Picard tools are altered only for Picard and not global. * program modes and memory limits (program specific),
* Whether chunking should be used
* set program executables (if for some reason the user does not want to use the systems default tools)
* One could set global variables containing settings for all tools used in the pipeline or set tool specific options one layer
deeper into the JSON file. E.g. in the example below the settings for Picard tools are altered only for Picard and not global.
~~~ ~~~
"picard": { "validationstringency": "LENIENT" } "picard": { "validationstringency": "LENIENT" }
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment