compare_data_frame_object_report {dataCompare} | R Documentation |
run the rmarkdown report of the data comparison and save it in an external directory
Description
run the rmarkdown report of the data comparison and save it in an external directory
Usage
compare_data_frame_object_report(
df1,
df2,
ids,
report_title = "Comparator report",
report_author = "Author name here",
report_context = "Add a small text here to explain the context."
)
Arguments
df1 |
The first dataframe of the comparison |
df2 |
The second dataframe of the comparison |
ids |
The character vector containing id variables which identify the observations in dataframe 'df1' and datafram 'df2' |
report_title |
A character string which contains the title of the report |
report_author |
A character string which contains the name of the report author |
report_context |
A character string containing the context of the report |
Value
null.
Examples
library(dplyr)
compare_data_frame_object_report(
df1 = iris %>% dplyr::mutate(ID = row_number()),
df2 = iris %>% dplyr::mutate(ID = row_number()),
ids = 'ID',
report_title = "Iris data Comparator report",
report_author = "Sergio Ewane",
report_context = "i'm checking if the two dataframe contains the same values"
)
[Package dataCompare version 1.0.5 Index]