Description

The VueGen nf-core module is designed to automate report generation from outputs produced by other modules, subworkflows, or pipelines. The module integrates the VueGen Python library and customizes it for compatibility with the Nextflow environment. VueGen automates the creation of reports from bioinformatics outputs, supporting formats like PDF, HTML, DOCX, ODT, PPTX, Reveal.js, Jupyter notebooks, and Streamlit web applications.

Input

name:type
description
pattern

input_type:string

Specifies whether the input is a configuration file (‘config’) or a directory (‘directory’).

^(config|directory)$

input_path:file

Path to the input directory or configuration file used by VueGen.

report_type:string

The type of report to generate. Options include ‘streamlit’, ‘html’, ‘pdf’, ‘docx’, ‘odt’, ‘revealjs’, ‘pptx’, and ‘jupyter’.

^(streamlit|html|pdf|docx|odt|revealjs|pptx|jupyter)$

Output

name:type
description
pattern

output_folder

*report:directory

The output directory containing the generated report files.

  • If report_type is ‘streamlit’, a ‘streamlit_report’ directory is created, containing subfolders for each section with Python scripts corresponding to the web application’s pages.
  • For other report types, a ‘quarto_report’ directory is generated, containing a Quarto Markdown (qmd) file that structures the entire report.
*report

versions

versions.yml:file

File containing software versions

versions.yml

Tools

vuegen
MIT

The VueGen nf-core module is designed to automate report generation from outputs produced by other modules, subworkflows, or pipelines. The module integrates the VueGen Python library and customizes it for compatibility with the Nextflow environment. VueGen automates the creation of reports from bioinformatics outputs, supporting formats like PDF, HTML, DOCX, ODT, PPTX, Reveal.js, Jupyter notebooks, and Streamlit web applications.