vt_render_validation_report: provide a nice wrapper to set states around render

View source: R/render_validation_report.R

vt_render_validation_reportR Documentation

provide a nice wrapper to set states around render

Description

This package is not intended for use by the end users. This is to be used within valtools packages.

Usage

vt_render_validation_report(
  report_path,
  output_dir = dirname(report_path),
  output_file = NULL,
  ...,
  render_time = c("build", "installed"),
  package = ""
)

Arguments

report_path

path to the validation report rmarkdown

output_dir

path to directory to output rendered report. defaults to same folder

output_file

expected output filename sans extension

...

arguments passed to render

render_time

type of rendering of validation to run, "build" or "installed".

package

the report type of rendering of validation to run, "build" or "installed".


phuse-org/valtools documentation built on Nov. 10, 2024, 1:36 a.m.