generate_report: Compare summary statistics for two datasets, given the...

In avantoss/vardist: vardist (http://github.com/avantcredit/vardist)

Description

In the list tests, some elements may be named after some of the summaries (which at this point are column names in baseline_stats).

Usage

generate_report(challenger_stats, baseline_stats, challenger_df, baseline_df,
  tests, parallel = FALSE, mc.cores = parallel::detectCores())

Arguments

challenger_stats	data.frame. Summaries for the challenger data frame, created by calculate_summaries.
baseline_stats	data.frame. Summaries for the baseline data frame, created by calculate_summaries.
challenger_df	data.frame.
baseline_df	data.frame.
tests	list. A named list of functions that compare the challenger and the baseline. See above for details.
parallel	logical. Should we use mclapply instead of lapply?
mc.cores	numeric. To be passed into mclapply.

Details

If an element in tests is named after a summary, then the element is expected to be a function that takes in the baseline statistic, the challenger statistic, and the respective columns. Otherwise, it is expected to take in the two columns.

Value

a data.frame of logical values showing if each test passed or failed for each column.

avantoss/vardist documentation built on May 24, 2019, 3:03 a.m.