From 031592654a78bf88e912f81530711d5989a06f2f Mon Sep 17 00:00:00 2001 From: "Dr. Ernie Prabhakar" <19791+drernie@users.noreply.github.com> Date: Wed, 11 Sep 2024 20:44:58 -0700 Subject: [PATCH] README: use plugin with S3 URIs --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 41864aec..ff322e63 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,22 @@ Nextflow plugin for reading and writing Quilt packages as a FileSystem developed by [Quilt Data](https://quiltdata.com/) that enables you read and write directly to Quilt packages using `quilt+s3` URIs wherever your Nextflow pipeline currently use `s3` URIs. -In v0.8+, the plugin can even be used with "native" URIs, and it will automatically register a Quilt package at the root of the bucket. +## NEW: Use nf-quilt plugin with existing S3 URIs -Inspired by the original [`nf-quilt`](https://github.com/nextflow-io/nf-quilt) plugin (v0.2.0) developed by Seqera labs. +In v0.8+, the plugin can even be used with "native" S3 URIs. You can continue using your exising S3 URIs,and Nextflow will write the data out as usual. However, simply by adding the `nf-quilt` plugin, you can also "overlay" that data with a Quilt package containing all the metadata from that run. + +For example: + +```shell +nextflow run nf-core/rnaseq -plugins nf-quilt --outdir "s3://quilt-example-bucket/test/nf_quilt_rnaseq" +# other parameters omitted for brevity +``` + +will automatically create the package: + +```url +quilt+s3://quilt-example-bucket#package=test/nf_quilt_rnaseq +``` ## I. Using the nf-quilt plugin in Production