Skip to content

Commit

Permalink
Update Getting-Start.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jiyue1214 authored Nov 4, 2024
1 parent c4d5cbf commit 2ad092a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/Tutorials/Getting-Start.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,12 @@ conda 23.11.0
## Run your first harmonisation pipeline
To run your first harmonization pipeline, execute the following command:
``` bash
nextflow run EBISPOT/gwas-sumstats-harmoniser --version $version -profile test,singularity
nextflow run EBISPOT/gwas-sumstats-harmoniser -r $release_version -profile test,singularity
```
🚨 If you did not choose to install Singularity, remember to replace `singularity` with `docker` or `conda`.

Once Nextflow starts running:
1. It will download the `gwas-sumstats-harmoniser` pipeline from Github into the global cache `~/.nextflow/assets`. (Please note that in the nextflow, `-r` determines which version of the pipeline to use, while `--version` will only decide what is recorded in the [`running.log`](../Explanation/output-folder-structure#running-log-summary-the-whole-harmonisation-process) file.)
1. It will download the `gwas-sumstats-harmoniser` pipeline from Github into the global cache `~/.nextflow/assets`. (Please note that in the nextflow, `-r` determines which version of the pipeline to use, for example, "v1.1.10"; while `--version` will only decide what is recorded in the [`running.log`](../Explanation/output-folder-structure#running-log-summary-the-whole-harmonisation-process) file.)
2. It will pull the Docker image from [Docker Hub](https://hub.docker.com/r/ebispot/gwas-sumstats-harmoniser) and built Singularity container.
3. Using the input files `random_name.tsv`,`random_name.tsv-meta.yaml` along with a small test reference file provided in the ` ~/.nextflow/assets/EBISPOT/gwas-sumstats-harmoniser/test_data`, it will execute the pipeline.
4. Once the pipeline executes, you can monitor the progress in the terminal, which may look like this:
Expand Down

0 comments on commit 2ad092a

Please sign in to comment.