psHarmonize (version 0.3.6)

create_error_log_report: Error log report creation

Description

This function will create an RMarkdown error log. It takes the harmonization object as the input, and will knit an RMarkdown html file to the path specified.

Note: The error log will only be able to detect "processing" errors, and not "content" errors. For example, if the user enters coding instructions that are nonsensical or incorrect, but are still able to be executed, this function will not be able to detect it.

Usage

create_error_log_report(
  harmonization_object,
  path = "./",
  file = "error_log_report.html"
)

Value

Does not return an object, but instead knits html RMarkdown report to specified path and file name.

Arguments

harmonization_object

Harmonization object

path

Path of output R Markdown report

file

Filename of output R Markdown report

Examples

# Examples not run

# Creating harmonized object using harmonization sheet with errors.
# harmonized_obj <- harmonization(harmonization_sheet = error_harmonization_sheet_example)

# Knitting error log report
# create_error_log_report(harmonization_object = harmonized_obj,
#   path = './',
#   file = 'example_output.html)