bidux (version 0.3.3)

bid_report: Generate BID Framework Report

Description

Creates a comprehensive report from a completed BID framework process. This report summarizes all stages and provides recommendations for implementation. Reports include component suggestions that work with both Shiny applications and Quarto dashboards (shiny-prefixed components (i.e., shiny::) require Shiny runtime).

Usage

bid_report(
  validate_stage,
  format = c("text", "html", "markdown"),
  include_diagrams = TRUE
)

Value

A formatted report summarizing the entire BID process

Arguments

validate_stage

A tibble output from bid_validate().

format

Output format: "text", "html", or "markdown"

include_diagrams

Logical, whether to include ASCII diagrams in the report (default: TRUE)

Examples

if (interactive()) {
  # After completing all 5 stages
  validation_result <- bid_validate(...)

  # Generate a text report
  bid_report(validation_result)

  # Generate an HTML report
  bid_report(validation_result, format = "html")

  # Generate a markdown report without diagrams
  bid_report(
    validation_result,
    format = "markdown",
    include_diagrams = FALSE
  )
}