Skip to contents

Generate a reproducible markdown report of the workflow

Usage

bg_export_report(project, path = NULL, format = c("html", "md"))

Arguments

project

A bg_handle.

path

Optional output path. Defaults to workflow_report.md or workflow_report.html in the project root depending on format.

format

Output format: markdown ("md") or html ("html").

Value

The path to the written report file.