Added explicit revision param to docs

Plant-Food-Research-Open · Oct 25, 2024 · 27a8d3b · 27a8d3b
1 parent fe7b8fc
commit 27a8d3b
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -102,6 +102,7 @@ Now, you can run the pipeline using:
 
 ```bash
 nextflow run plant-food-research-open/assemblyqc \
+  -revision <version> \
    -profile <docker/singularity/.../institute> \
    --input assemblysheet.csv \
    --outdir <OUTDIR>

diff --git a/conf/test.config b/conf/test.config
@@ -5,7 +5,7 @@
     Defines input files and everything required to run a fast and simple pipeline test.
 
     Use as follows:
-        nextflow run plant-food-research-open/assemblyqc -profile test,<docker/singularity> --outdir <OUTDIR>
+        nextflow run plant-food-research-open/assemblyqc -revision <version> -profile test,<docker/singularity> --outdir <OUTDIR>
 
 ----------------------------------------------------------------------------------------
 */

diff --git a/conf/test_full.config b/conf/test_full.config
@@ -5,7 +5,7 @@
     Defines input files and everything required to run a full size pipeline test.
 
     Use as follows:
-        nextflow run plant-food-research-open/assemblyqc -profile test_full,<docker/singularity> --outdir <OUTDIR>
+        nextflow run plant-food-research-open/assemblyqc -revision <version> -profile test_full,<docker/singularity> --outdir <OUTDIR>
 
 ----------------------------------------------------------------------------------------
 */

diff --git a/docs/usage.md b/docs/usage.md
@@ -136,7 +136,7 @@ All the modules have been tested to work on a single machine with 10 CPUs + 32 G
 The typical command for running the pipeline is as follows:
 
 ```bash
-nextflow run plant-food-research-open/assemblyqc --input ./assemblysheet.csv --outdir ./results -profile docker
+nextflow run plant-food-research-open/assemblyqc -revision <version> --input ./assemblysheet.csv --outdir ./results -profile docker
 ```
 
 This will launch the pipeline with the `docker` configuration profile. See below for more information about profiles.
@@ -160,7 +160,7 @@ Pipeline settings can be provided in a `yaml` or `json` file via `-params-file <
 The above pipeline run specified with a params file in yaml format:
 
 ```bash
-nextflow run plant-food-research-open/assemblyqc -profile docker -params-file params.yaml
+nextflow run plant-food-research-open/assemblyqc -revision main -profile docker -params-file params.yaml
 ```
 
 with: