Skip to content

Commit 798c48c

Browse files
committed
📝 Update README with info for installing and running nf-vuegen
1 parent 06fb961 commit 798c48c

File tree

1 file changed

+44
-1
lines changed

1 file changed

+44
-1
lines changed

README.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,14 @@ If you prefer not to install VueGen on your system, a pre-configured Docker cont
104104

105105
### Nextflow and nf-core
106106

107-
VueGen is also available as a [nf-core][nfcore] module, customised for compatibility with the [Nextflow][nextflow] environment. This module is designed to automate report generation from outputs produced by other modules, subworkflows, or pipelines. You can read the offical documentation for the nf-core module [here][nf-vuegen-nf-core]. Also, the source code and additional details are available in the [nf-VueGen repository][nf-vuegen].
107+
VueGen is also available as a [nf-core][nfcore] module, customised for compatibility with the [Nextflow][nextflow] environment. This module is designed to automate report generation from outputs produced by other modules, subworkflows, or pipelines. Asumming that you have `nextflow` and `nf-core` installed, you can use the following command to install the nf-core module:
108+
109+
```bash
110+
nf-core modules install vuegen
111+
```
112+
113+
> [!NOTE]
114+
> You can read the offical documentation for the nf-core module [here][nf-vuegen-nf-core]. Also, the source code and additional details are available in the [nf-VueGen repository][nf-vuegen].
108115
109116
## Execution
110117

@@ -177,6 +184,42 @@ docker run --rm \
177184
quay.io/dtu_biosustain_dsp/vuegen:v0.3.2-docker --directory /home/appuser/Earth_microbiome_vuegen_demo_notebook --report_type streamlit
178185
```
179186

187+
### Running VueGen with Nextflow and nf-core
188+
189+
To run VueGen as a nf-core module, you should create a Nextflow pipeline and include the VueGen module in your workflow. Here is a `main.nf` example:
190+
191+
```groovy
192+
#!/usr/bin/env nextflow
193+
include { VUEGEN } from './modules/nf-core/vuegen/'
194+
195+
workflow {
196+
// Create a channel for the report type
197+
report_type_ch = Channel.value(params.report_type)
198+
199+
// Handle configuration file and directory inputs
200+
if (params.config) {
201+
file_ch = Channel.fromPath(params.config)
202+
input_type_ch = Channel.value('config')
203+
output_ch = VUEGEN(input_type_ch, file_ch, report_type_ch)
204+
205+
} else if (params.directory) {
206+
dir_ch = Channel.fromPath(params.directory, type: 'dir', followLinks: true)
207+
input_type_ch = Channel.value('directory')
208+
output_ch = VUEGEN(input_type_ch, dir_ch, report_type_ch)
209+
210+
}
211+
}
212+
```
213+
214+
You can run the pipeline with the following command:
215+
216+
```bash
217+
nextflow run main.nf --directory docs/example_data/Basic_example_vuegen_demo_notebook --report_type html
218+
```
219+
220+
> [!NOTE]
221+
> You can read the offical documentation for the nf-core module [here][nf-vuegen-nf-core]. Also, the source code and additional details are available in the [nf-VueGen repository][nf-vuegen].
222+
180223
## GUI
181224

182225
We have a simple GUI for VueGen that can be run locally or through a standalone executable.

0 commit comments

Comments
 (0)