vuegen.quarto_reportview module

QuartoReportView class for generating Quarto reports.

class vuegen.quarto_reportview.QuartoReportView(report: Report, report_type: ReportType, quarto_checks: bool = False, output_dir: Path | None = PosixPath('quarto_report'), static_dir: str = PosixPath('quarto_report/static'))

Bases: ReportView

A ReportView subclass for generating Quarto reports.

BASE_DIR = PosixPath('quarto_report')

STATIC_FILES_DIR = PosixPath('quarto_report/static')

generate_report(output_dir: Path | None = None) → None

Generates the qmd file of the quarto report. It creates code for rendering each section and its subsections with all components.

Parameters:

output_dir (Path, optional) – The folder where the generated report files will be saved. Will overwrite value set on initialization of QuartoReportView.

run_report(output_dir: Path | None = None) → None

Runs the generated quarto report.

Parameters:

output_dir (str, optional) – The folder where the report was generated (default is ‘sections’).