Skip to content

Commit 4e3dded

Browse files
author
Szilveszter Juhos
authored
Merge pull request nf-core#585 from szilvajuhos/master
Minor doc changes
2 parents 26f2f78 + 76f07b7 commit 4e3dded

3 files changed

Lines changed: 5 additions & 39 deletions

File tree

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,6 @@ For further information or help, don't hesitate to get in touch on [Gitter][gitt
9898
* [Marcel Martin](https://github.com/marcelm)
9999
* [Björn Nystedt](https://github.com/bjornnystedt)
100100
* [Pall Olason](https://github.com/pallolason)
101-
* [Pelin Sahlén](https://github.com/pelinakan)
102101

103102
--------------------------------------------------------------------------------
104103

configuration/base.config

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ timeline { // Turning on timeline tracking by default
7171
trace { // Turning on trace tracking by default
7272
enabled = true
7373
fields = 'process,task_id,hash,name,attempt,status,exit,realtime,%cpu,vmem,rss,submit,start,complete,duration,realtime,rchar,wchar'
74-
file = "${params.outDir}/Reports/Sarek_trace.html"
74+
file = "${params.outDir}/Reports/Sarek_trace.txt"
7575
}
7676

7777
// Function to ensure that resource requirements don't go beyond

doc/INSTALL.md

Lines changed: 4 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -26,46 +26,13 @@ export NXF_SINGULARITY_CACHEDIR=$HOME/.singularity
2626

2727
Docker can also be used as a container technology.
2828

29-
## Test Sarek with small dataset and small reference
29+
You can [Test Sarek with small dataset and small reference](https://github.com/SciLifeLab/Sarek/blob/master/doc/TESTS.md)
3030

31-
The following tutorial explain how to run Sarek on a small dataset using a small reference.
32-
33-
```bash
34-
# Connect to your system
35-
> ssh -AX [USER]@[system]
36-
# Or just open a terminal
37-
38-
# Install Nextflow
39-
> curl -s https://get.nextflow.io | bash
40-
41-
# Move Nextflow into your $PATH
42-
> mv nextflow $HOME/bin
43-
44-
# Set up the cache directory for Singularity Images if needed
45-
> export NXF_SINGULARITY_CACHEDIR=$HOME/.singularity
46-
47-
# make a test directory
48-
> mkdir test_Sarek
49-
> cd test_Sarek
50-
51-
# Download and build the smallGRCh37 reference using Singularity
52-
> nextflow run SciLifeLab/Sarek/buildReferences.nf --download --genome smallGRCh37 -profile singularity
53-
54-
# Or download and build the smallGRCh37 reference using Docker
55-
> nextflow run SciLifeLab/Sarek/buildReferences.nf --download --genome smallGRCh37 -profile docker
56-
57-
# Test Sarek on a test tiny set using Singularity
58-
> nextflow run SciLifeLab/Sarek/main.nf --test --genome smallGRCh37 --noReports -profile singularity
59-
60-
# Or test Sarek on a test tiny set using Docker
61-
> nextflow run SciLifeLab/Sarek/main.nf --test --genome smallGRCh37 --noReports -profile docker
62-
```
63-
64-
## Update
31+
## Update
6532

6633
To update Sarek, it's also very simple:
6734

68-
35+
6936
```bash
7037
# Connect to your system
7138
> ssh -AX [USER]@[system]REFERENCES
@@ -75,7 +42,7 @@ To update Sarek, it's also very simple:
7542
> nextflow pull SciLifeLab/Sarek
7643
```
7744

78-
## Run Sarek on real data
45+
## Running Sarek with real data
7946

8047
Follow the [references documentation](REFERENCES.md) on how to download/build the references files.
8148

0 commit comments

Comments
 (0)