create_summary_report {psHarmonize} | R Documentation |
Summary report creation
Description
Summary report creation
Usage
create_summary_report(
harmonization_object,
path = "./",
file = "summary_report.html",
compare = FALSE
)
Arguments
harmonization_object |
Harmonization object |
path |
Path of output R Markdown report |
file |
Filename of output R Markdown report |
compare |
Creates summary report with comparison of raw values with modified values |
Value
Does not return an object, but instead knits html RMarkdown report to specified path and file name.
Examples
# Examples not run
# Creating harmonized object
# harmonized_obj <- harmonization(harmonization_sheet = harmonization_sheet_example)
# Knitting summary report
# create_summary_report(harmonization_object = harmonized_obj,
# path = './',
# file = 'example_output.html)
# Use `compare` option to create comparison summary report.
# create_summary_report(harmonization_object = harmonized_obj,
# path = './',
# file = 'example_output.html,
# compare = TRUE)
[Package psHarmonize version 0.3.5 Index]