Skip to content

Commit 432661d

Browse files
authored
Merge pull request nf-core#637 from MaxUlysse/Docs
Update more Docs
2 parents be2e519 + 9331bb1 commit 432661d

20 files changed

Lines changed: 112 additions & 195 deletions

.github/RELEASE_CHECKLIST.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ This checklist is for our own reference
1818
6. Commit and push version updates
1919
7. Make a [release](https://github.com/SciLifeLab/Sarek/releases) on GitHub
2020
8. Choose an appropriate codename for the release
21-
9. Tweet that new version is released
22-
10. Commit and push. Continue making more awesome :metal:
23-
11. Have fika :cake:
21+
9. Update [bio.tools](https://bio.tools/Sarek) with the new release
22+
10. Tweet that new version is released
23+
11. Commit and push. Continue making more awesome :metal:
24+
12. Have fika :cake:

CHANGELOG.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
1919
- [#615](https://github.com/SciLifeLab/Sarek/pull/615) - Use `splitCsv` instead of `readlines`
2020
- [#621](https://github.com/SciLifeLab/Sarek/pull/621) - Improve install script
2121
- [#621](https://github.com/SciLifeLab/Sarek/pull/621) - Simplify tests
22-
- [#627](https://github.com/SciLifeLab/Sarek/pull/627), [#629](https://github.com/SciLifeLab/Sarek/pull/629) - Refactor docs
22+
- [#627](https://github.com/SciLifeLab/Sarek/pull/627), [#629](https://github.com/SciLifeLab/Sarek/pull/629), [#637](https://github.com/SciLifeLab/Sarek/pull/637) - Refactor docs
2323
- [#629](https://github.com/SciLifeLab/Sarek/pull/629) - Refactor config
2424
- [#632](https://github.com/SciLifeLab/Sarek/pull/632) - Use 2 threads and 2 cpus FastQC processes
25+
- [#637](https://github.com/SciLifeLab/Sarek/pull/637) - Update tool version gathering
2526

2627
### `Removed`
2728
- [#616](https://github.com/SciLifeLab/Sarek/pull/616) - Remove old Issue Template
2829
- [#629](https://github.com/SciLifeLab/Sarek/pull/629) - Remove old Dockerfiles
30+
- [#637](https://github.com/SciLifeLab/Sarek/pull/637) - Remove old comments
2931

3032
### `Fixed`
3133
- [#621](https://github.com/SciLifeLab/Sarek/pull/621) - Fix VEP tests
32-
34+
- [#637](https://github.com/SciLifeLab/Sarek/pull/637) - Fix links in MD files
3335
## [2.1.0] - Ruotes - 2018-08-14
3436

3537
### `Added`

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# [![Sarek](https://raw.githubusercontent.com/SciLifeLab/Sarek/master/docs/images/Sarek_logo.png "Sarek")](http://opensource.scilifelab.se/projects/sarek/)
1+
# [![Sarek](https://raw.githubusercontent.com/SciLifeLab/Sarek/master/docs/images/Sarek_logo.png "Sarek")](http://sarek.scilifelab.se/)
22

33
#### An open-source analysis pipeline to detect germline or somatic variants from whole genome sequencing
44

@@ -21,7 +21,7 @@ Previously known as the Cancer Analysis Workflow (CAW),
2121
Sarek is a workflow designed to run analyses on WGS data from regular samples or tumour / normal pairs, including relapse samples if required.
2222

2323
It's built using [Nextflow][nextflow-link], a domain specific language for workflow building.
24-
Software dependencies are handled using [Docker](https://www.docker.com) or [Singularity](http://singularity.lbl.gov) - container technologies that provide excellent reproducibility and ease of use.
24+
Software dependencies are handled using [Docker](https://www.docker.com) or [Singularity](https://www.sylabs.io/singularity/) - container technologies that provide excellent reproducibility and ease of use.
2525
Singularity has been designed specifically for high-performance computing environments.
2626
This means that although Sarek has been primarily designed for use with the Swedish [UPPMAX HPC systems](https://www.uppmax.uu.se), it should be able to run on any system that supports these two tools.
2727

annotate.nf

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,13 @@ kate: syntax groovy; space-indent on; indent-width 2;
2626
https://github.com/SciLifeLab/Sarek/README.md
2727
--------------------------------------------------------------------------------
2828
Processes overview
29-
- RunBcftoolsStats - Run BCFTools stats on vcf before annotation
29+
- RunBcftoolsStats - Run BCFTools stats on vcf files
30+
- RunVcftools - Run VCFTools on vcf files
3031
- RunSnpeff - Run snpEff for annotation of vcf files
3132
- RunVEP - Run VEP for annotation of vcf files
33+
- CompressVCF - Compress and index vcf files using tabix
34+
- GetVersionSnpeff - Get version of tools
35+
- GetVersionVEP - Get version of tools
3236
================================================================================
3337
= C O N F I G U R A T I O N =
3438
================================================================================
@@ -89,8 +93,6 @@ vcfNotToAnnotate.close()
8993

9094
// as now have the list of VCFs to annotate, the first step is to annotate with allele frequencies, if there are any
9195

92-
93-
9496
(vcfForBCFtools, vcfForVCFtools, vcfForSnpeff, vcfForVep) = vcfToAnnotate.into(4)
9597

9698
vcfForVep = vcfForVep.map {
@@ -265,7 +267,7 @@ if (params.verbose) vcfCompressedoutput = vcfCompressedoutput.view {
265267
"Index : ${it[3].fileName}"
266268
}
267269

268-
process GetVersionSnpEFF {
270+
process GetVersionSnpeff {
269271
publishDir directoryMap.version, mode: 'link'
270272
output: file("v_*.txt")
271273
when: 'snpeff' in tools || 'merge' in tools

buildReferences.nf

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ kate: syntax groovy; space-indent on; indent-width 2;
2626
https://github.com/SciLifeLab/Sarek/README.md
2727
--------------------------------------------------------------------------------
2828
Processes overview
29-
- ProcessReference - Download all references if needed
3029
- DecompressFile - Extract files if needed
3130
- BuildBWAindexes - Build indexes for BWA
3231
- BuildReferenceIndex - Build index for FASTA refs
@@ -144,7 +143,7 @@ process BuildReferenceIndex {
144143
}
145144

146145
if (params.verbose) ch_referenceIndex.view {
147-
"Reference index : ${it.fileName}"
146+
"Reference index : ${it.fileName}"
148147
}
149148

150149
process BuildSAMToolsIndex {

conf/containers.config

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -38,36 +38,9 @@ process {
3838
withName:GetVersionASCAT {
3939
container = "${params.repository}/r-base:${params.tag}"
4040
}
41-
withName:GetVersionBamQC {
42-
container = "${params.repository}/sarek:${params.tag}"
43-
}
44-
withName:GetVersionBCFtools {
45-
container = "${params.repository}/sarek:${params.tag}"
46-
}
47-
withName:GetVersionBWAsamtools {
48-
container = "${params.repository}/sarek:${params.tag}"
49-
}
50-
withName:GetVersionFastQC {
51-
container = "${params.repository}/sarek:${params.tag}"
52-
}
53-
withName:GetVersionFreeBayes {
54-
container = "${params.repository}/sarek:${params.tag}"
55-
}
56-
withName:GetVersionGATK {
57-
container = "${params.repository}/sarek:${params.tag}"
58-
}
59-
withName:GetVersionManta {
60-
container = "${params.repository}/sarek:${params.tag}"
61-
}
6241
withName:GetVersionSnpeff {
6342
container = {params.genome == 'GRCh38' ? "${params.repository}/snpeffgrch38:${params.tag}" : "${params.repository}/snpeffgrch37:${params.tag}"}
6443
}
65-
withName:GetVersionStrelka {
66-
container = "${params.repository}/sarek:${params.tag}"
67-
}
68-
withName:GetVersionVCFtools {
69-
container = "${params.repository}/sarek:${params.tag}"
70-
}
7144
withName:GetVersionVEP {
7245
container = {params.genome == 'GRCh38' ? "${params.repository}/vepgrch38:${params.tag}" : "${params.repository}/vepgrch37:${params.tag}"}
7346
}

conf/singularity-path.config

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -43,42 +43,12 @@ process {
4343
withName:GetVersionASCAT {
4444
container = "${params.containerPath}/r-base-${params.tag}.img"
4545
}
46-
withName:GetVersionBamQC {
47-
container = "${params.containerPath}/sarek-${params.tag}.img"
48-
}
49-
withName:GetVersionBCFtools {
50-
container = "${params.containerPath}/sarek-${params.tag}.img"
51-
}
52-
withName:GetVersionBWAsamtools {
53-
container = "${params.containerPath}/sarek-${params.tag}.img"
54-
}
55-
withName:GetVersionFastQC {
56-
container = "${params.containerPath}/sarek-${params.tag}.img"
57-
}
58-
withName:GetVersionFreeBayes {
59-
container = "${params.containerPath}/sarek-${params.tag}.img"
60-
}
61-
withName:GetVersionGATK {
62-
container = "${params.containerPath}/sarek-${params.tag}.img"
63-
}
64-
withName:GetVersionManta {
65-
container = "${params.containerPath}/sarek-${params.tag}.img"
66-
}
6746
withName:GetVersionSnpeff {
6847
container = {params.genome == 'GRCh38' ? "${params.containerPath}/snpeffgrch38-${params.tag}.img" : "${params.containerPath}/snpeffgrch37-${params.tag}.img"}
6948
}
70-
withName:GetVersionStrelka {
71-
container = "${params.containerPath}/sarek-${params.tag}.img"
72-
}
73-
withName:GetVersionVCFtools {
74-
container = "${params.containerPath}/sarek-${params.tag}.img"
75-
}
7649
withName:GetVersionVEP {
7750
container = {params.genome == 'GRCh38' ? "${params.containerPath}/vepgrch38-${params.tag}.img" : "${params.containerPath}/vepgrch37-${params.tag}.img"}
7851
}
79-
withName:IndelRealigner {
80-
container = "${params.containerPath}/sarek-${params.tag}.img"
81-
}
8252
withName:MapReads {
8353
container = "${params.containerPath}/sarek-${params.tag}.img"
8454
}
@@ -88,9 +58,6 @@ process {
8858
withName:MergeBams {
8959
container = "${params.containerPath}/sarek-${params.tag}.img"
9060
}
91-
withName:RealignerTargetCreator {
92-
container = "${params.containerPath}/sarek-${params.tag}.img"
93-
}
9461
withName:RecalibrateBam {
9562
container = "${params.containerPath}/sarek-${params.tag}.img"
9663
}

conf/uppmax-localhost.config

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,6 @@ process {
6262
cpus = 16
6363
memory = {params.totalMemory}
6464
}
65-
withName:IndelRealigner {
66-
memory = {params.singleCPUMem * 2 * task.attempt}
67-
}
6865
withName:MapReads {
6966
cpus = 16
7067
memory = {params.totalMemory}
@@ -78,10 +75,6 @@ process {
7875
cpus = 16
7976
memory = {params.totalMemory}
8077
}
81-
withName:RealignerTargetCreator {
82-
cpus = 4
83-
memory = {params.singleCPUMem * 4 * task.attempt}
84-
}
8578
withName:RecalibrateBam {
8679
memory = {params.singleCPUMem * task.attempt}
8780
}

conf/uppmax-slurm.config

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,6 @@ process {
4242
queue = 'core'
4343
time = {params.runTime * task.attempt}
4444
}
45-
withName:IndelRealigner {
46-
cpus = 1
47-
memory = {params.singleCPUMem * task.attempt}
48-
queue = 'core'
49-
time = {params.runTime * task.attempt}
50-
}
5145
withName:MapReads {
5246
time = {params.runTime * task.attempt}
5347
}
@@ -61,9 +55,6 @@ process {
6155
queue = 'core'
6256
time = {params.runTime * task.attempt}
6357
}
64-
withName:RealignerTargetCreator {
65-
time = {params.runTime * task.attempt}
66-
}
6758
withName:RecalibrateBam {
6859
cpus = 8
6960
memory = {params.singleCPUMem * 8 * task.attempt}

docs/CONFIG.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,41 +12,41 @@ The standard ones are designed to work on a Swedish UPPMAX clusters, and can be
1212
Every configuration file can be modified for your own use.
1313
If you want you can specify the use of a config file using `-c <config file>`
1414

15-
### [`containers.config`](https://github.com/SciLifeLab/Sarek/blob/master/configuration/containers.config)
15+
### [`containers.config`](https://github.com/SciLifeLab/Sarek/blob/master/conf/containers.config)
1616

1717
Define Containers for all process.
1818
Images will be pulled automatically.
1919
Use in your own profile if needed.
2020

21-
### [`docker.config`](https://github.com/SciLifeLab/Sarek/blob/master/configuration/docker.config)
21+
### [`docker.config`](https://github.com/SciLifeLab/Sarek/blob/master/conf/docker.config)
2222

2323
Define Docker Containers for all process.
2424
Images will be pulled automatically.
2525
Use in your own profile if needed.
2626

27-
### [`genomes.config`](https://github.com/SciLifeLab/Sarek/blob/master/configuration/genomes.config)
27+
### [`genomes.config`](https://github.com/SciLifeLab/Sarek/blob/master/conf/genomes.config)
2828

2929
Contain path to all references.
3030
Modify it if you want to change genome version, or the path to your references files.
3131

32-
### [`singularity-path.config`](https://github.com/SciLifeLab/Sarek/blob/master/configuration/singularity-path.config)
32+
### [`singularity-path.config`](https://github.com/SciLifeLab/Sarek/blob/master/conf/singularity-path.config)
3333

3434
Define path to Singularity Containers for all process.
3535
To be used when downloading Singularity Containers, like on a secure UPPMAX cluster.
3636
Images will not be pulled automatically.
3737
You need to set them up before.
3838

39-
### [`singularity.config`](https://github.com/SciLifeLab/Sarek/blob/master/configuration/singularity.config)
39+
### [`singularity.config`](https://github.com/SciLifeLab/Sarek/blob/master/conf/singularity.config)
4040

4141
Define Singularity Containers for all process.
4242
Images will be pulled automatically.
4343
Use in your own profile if needed.
4444

45-
### [`travis.config`](https://github.com/SciLifeLab/Sarek/blob/master/configuration/travis.config)
45+
### [`travis.config`](https://github.com/SciLifeLab/Sarek/blob/master/conf/travis.config)
4646

4747
To be used for Travis (2 cpus) or on small computer for testing purpose
4848

49-
### [`uppmax-slurm.config`](https://github.com/SciLifeLab/Sarek/blob/master/configuration/uppmax-slurm.config)
49+
### [`uppmax-slurm.config`](https://github.com/SciLifeLab/Sarek/blob/master/conf/uppmax-slurm.config)
5050

5151
Slurm configuration for a UPPMAX cluster
5252
Will run the workflow on `/scratch` using the Nextflow [`scratch`](https://www.nextflow.io/docs/latest/process.html#scratch) directive

0 commit comments

Comments
 (0)