Skip to content

Commit 29a394a

Browse files
authored
Merge pull request #86 from jfy133/patch-1
Patch 1
2 parents 018406c + cbe8605 commit 29a394a

1 file changed

Lines changed: 17 additions & 4 deletions

File tree

docs/configuration/local.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ First, install docker on your system: [Docker Installation Instructions](https:/
1111

1212
Then, simply run the analysis pipeline:
1313
```bash
14-
nextflow run nf-core/eager -profile docker --reads '<path to your reads>'
14+
nextflow run nf-core/eager -profile docker --reads '<path to your reads>' --pairedEnd
1515
```
1616

1717
Nextflow will recognise `nf-core/eager` and download the pipeline from GitHub. The `-profile docker` configuration lists the [nf-core/eager](https://hub.docker.com/r/nfcore/eager/) image that we have created and is hosted at dockerhub, and this is downloaded.
@@ -23,9 +23,13 @@ The public docker images are tagged with the same version numbers as the code, w
2323

2424

2525
## Singularity image
26-
Many HPC environments are not able to run Docker due to security issues. [Singularity](http://singularity.lbl.gov/) is a tool designed to run on such HPC systems which is very similar to Docker. Even better, it can use create images directly from dockerhub.
26+
Many HPC environments are not able to run Docker due to security issues. [Singularity](http://singularity.lbl.gov/) is a tool designed to run on such HPC systems which is very similar to Docker. There is a particular profile that will download the singularity image for you.
2727

28-
To use the singularity image for a single run, use `-with-singularity 'docker://nfcore/eager'`. This will download the docker container from dockerhub and create a singularity image for you dynamically.
28+
```bash
29+
nextflow run nf-core/eager -profile singularity --reads '<path to your reads>' --pairedEnd
30+
```
31+
32+
Additionally, it can use create images directly from dockerhub. To use the singularity image for a single run, use `-with-singularity 'docker://nfcore/eager'`. This will download the docker container from dockerhub and create a singularity image for you dynamically.
2933

3034
If you intend to run the pipeline offline, nextflow will not be able to automatically download the singularity image for you. Instead, you'll have to do this yourself manually first, transfer the image file and then point to that.
3135

@@ -38,5 +42,14 @@ singularity pull --name nf-core-eager.img docker://nfcore/eager
3842
Then transfer this file and run the pipeline with this path:
3943

4044
```bash
41-
nextflow run /path/to/nf-core/eager -with-singularity /path/to/nf-core-eager.img
45+
nextflow run /path/to/nf-core/eager -with-singularity /path/to/nf-core-eager.img --reads --pairedEnd
4246
```
47+
48+
## Conda
49+
50+
You may also use conda (utilising the bioconda repository) to download the pipeline dependencies for you.
51+
52+
```bash
53+
nextflow run nf-core/eager -profile conda --reads '<path to your reads>' --pairedEnd
54+
```
55+

0 commit comments

Comments
 (0)