diff --git a/docs/params.md b/docs/params.md index f27a5e2..3e52fab 100644 --- a/docs/params.md +++ b/docs/params.md @@ -93,9 +93,9 @@ Reference genome related files and options required for the workflow. | Parameter | Description | Type | Default | Required | Hidden | |-----------|-----------|-----------|-----------|-----------|-----------| -| `download_functional` | Whether to dowload functional references | `boolean` | True | | | -| `download_kaiju` | Whether to dowload the Kaiju reference db | `boolean` | True | | | -| `download_kraken` | Whether to dowload the Kraken2 reference db | `boolean` | | | | +| `download_functional` | Whether to download functional references | `boolean` | True | | | +| `download_kaiju` | Whether to download the Kaiju reference db | `boolean` | True | | | +| `download_kraken` | Whether to download the Kraken2 reference db | `boolean` | | | | | `download_host` | Whether to download the host reference genome | `boolean` | | | | | `functional_db` | Functional reference URL (download entry) | `string` | https://ftp.ncbi.nlm.nih.gov/blast/db/FASTA/nr.gz | | | | `functional_dictionary` | Functional dictionary URL (download entry) | `string` | https://ftp.uniprot.org/pub/databases/uniprot/current_release/knowledgebase/idmapping/idmapping.dat.gz | | | diff --git a/docs/usage.md b/docs/usage.md index 4c06784..05c64b7 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -94,7 +94,7 @@ Several generic profiles are bundled with the pipeline which instruct the pipeli Note that multiple profiles can be loaded, for example: `-profile test,docker` - the order of arguments is important! They are loaded in sequence, so later profiles can overwrite earlier profiles. -If `-profile` is not specified, the pipeline will run locally and expect all software to be installed and available on the `PATH`. This is _not_ recommended, since it can lead to different results on different machines dependent on the computer enviroment. +If `-profile` is not specified, the pipeline will run locally and expect all software to be installed and available on the `PATH`. This is _not_ recommended, since it can lead to different results on different machines dependent on the computer environment. - `test` - A profile with a complete configuration for automated testing @@ -164,7 +164,7 @@ Tip: you can replicate the issue by changing to the process work dir and enterin #### For beginners -A first step to bypass this error, you could try to increase the amount of CPUs, memory, and time for the whole pipeline. Therefor you can try to increase the resource for the parameters `--max_cpus`, `--max_memory`, and `--max_time`. Based on the error above, you have to increase the amount of memory. Therefore you can go to the [parameter documentation of rnaseq](https://nf-co.re/rnaseq/3.9/parameters) and scroll down to the `show hidden parameter` button to get the default value for `--max_memory`. In this case 128GB, you than can try to run your pipeline again with `--max_memory 200GB -resume` to skip all process, that were already calculated. If you can not increase the resource of the complete pipeline, you can try to adapt the resource for a single process as mentioned below. +A first step to bypass this error, you could try to increase the amount of CPUs, memory, and time for the whole pipeline. Therefore you can try to increase the resource for the parameters `--max_cpus`, `--max_memory`, and `--max_time`. Based on the error above, you have to increase the amount of memory. Therefore you can go to the [parameter documentation of rnaseq](https://nf-co.re/rnaseq/3.9/parameters) and scroll down to the `show hidden parameter` button to get the default value for `--max_memory`. In this case 128GB, you than can try to run your pipeline again with `--max_memory 200GB -resume` to skip all process, that were already calculated. If you can not increase the resource of the complete pipeline, you can try to adapt the resource for a single process as mentioned below. #### Advanced option on process level diff --git a/lib/WorkflowEuryale.groovy b/lib/WorkflowEuryale.groovy index 5d3865f..bab356f 100755 --- a/lib/WorkflowEuryale.groovy +++ b/lib/WorkflowEuryale.groovy @@ -39,7 +39,7 @@ class WorkflowEuryale { } public static String methodsDescriptionText(run_workflow, mqc_methods_yaml) { - // Convert to a named map so can be used as with familar NXF ${workflow} variable syntax in the MultiQC YML file + // Convert to a named map so that it can be used with a familiar NXF ${workflow} variable syntax in the MultiQC YML file def meta = [:] meta.workflow = run_workflow.toMap() meta["manifest_map"] = run_workflow.manifest.toMap() diff --git a/nextflow.config b/nextflow.config index 139a466..1dfcbda 100644 --- a/nextflow.config +++ b/nextflow.config @@ -49,7 +49,7 @@ params { skip_alignment = false skip_microview = false - // Dowload entry options + // Download entry options download_functional = true download_kaiju = true download_kraken = false diff --git a/nextflow_schema.json b/nextflow_schema.json index c8f1b68..6796a10 100644 --- a/nextflow_schema.json +++ b/nextflow_schema.json @@ -242,16 +242,16 @@ "download_functional": { "type": "boolean", "default": true, - "description": "Whether to dowload functional references" + "description": "Whether to download functional references" }, "download_kaiju": { "type": "boolean", "default": true, - "description": "Whether to dowload the Kaiju reference db" + "description": "Whether to download the Kaiju reference db" }, "download_kraken": { "type": "boolean", - "description": "Whether to dowload the Kraken2 reference db" + "description": "Whether to download the Kraken2 reference db" }, "download_host": { "type": "boolean", @@ -471,4 +471,4 @@ "$ref": "#/definitions/generic_options" } ] -} \ No newline at end of file +}