Instruct blueprint to generate kfa report

bp_export_kfa_report(
  bp,
  scale,
  path = NULL,
  path_pattern = NULL,
  format = NULL,
  title = NULL,
  kfa_args = list(),
  ...
)

Arguments

bp: A blueprint
scale: Which scale(s) to analyze
path: Path(s) to where the report(s) should be saved
path_pattern: Override the default location to save files (always rooted to the project root with here::here())
format: The output format of the report(s)
title: Optional title of report
kfa_args: Arguments forwarded to kfa::kfa() for this batch of scales
...: Arguments forwarded to the executing engine e.g. targets::tar_target_raw() or drake::target()

Value

An amended blueprint with the kfa report export instructions

Examples

if (FALSE) { # \dontrun{
test_bp <- blueprint(
  "mtcars_dat",
  description = "The mtcars dataset",
  command = mtcars
)

new_bp <- test_bp %>% bp_export_codebook()
} # }