Generate a Markdown conversion report — generate

Summarizes a conversion run: files converted, warnings raised by the conversion engines, and validation results, so a user can see at a glance what needs a manual look instead of hunting through console output.

Usage

generate_report(results, output = NULL)

Arguments

results: A conversion result from convert_file(), or a list of results such as the one returned by convert_directory().
output: Path to write the report. NULL returns the report as a string without writing a file.

Value

Invisibly, the report as a single string (one \n-joined Markdown document).