From f5364e45e7c007d9da5b24dcb50c5329b53b36ae Mon Sep 17 00:00:00 2001 From: Evan Floden Date: Fri, 6 Mar 2020 11:27:44 +0100 Subject: [PATCH] Update google.md or markdown linting --- docs/google.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/google.md b/docs/google.md index d3a65f5..0534a0b 100644 --- a/docs/google.md +++ b/docs/google.md @@ -2,33 +2,36 @@ To be used with the `google` profile by specifying the `-profile google` when running nf-core pipelines. - ![Google Cloud](images/google-cloud-logo.svg "https://cloud.google.com/life-sciences/docs/tutorials/nextflow") - ## Quick Start -``` + +```bash GOOGLE_APPLICATION_CREDENTIALS=.json NXF_MODE=google nextflow run nf-core/rnaseq -profile google,test --google_bucket ``` ### Required Parameters + #### `--google-bucket` + The Google Cloud Storage bucket location to be used as a Nextflow work directory. Can also be specified with (`-w gs://your_bucket/work`). ### Optional Parameters + #### `--google-zone` + The Google zone where the computation is executed in Compute Engine VMs. Multiple zones can be provided separating them by a comma. Default (`europe-west2-c`). #### `--google-preemptible` + Enables the usage of preemptible virtual machines with a retry error statergy for up to 5 retries. Default (`true`). #### `--google-debug` + Copies the /google debug directory from the VM to the task bucket directory. Useful for debugging. Default (`false`). - ## Cloud Life Sciences Setup + Please refer to the [Google Cloud](https://cloud.google.com/life-sciences/docs/tutorials/nextflow) and [Nextflow](https://www.nextflow.io/docs/latest/google.html#cloud-life-sciences) documentation which describe how to setup the Google Cloud environment. - -