modelPerformance_Report: Produce a standard model performance report

In dnegrey/miscTools: R package with miscellaneous tools

Description

modelPerformance_Report produces a flexdashboard report based on a mt_modelPerformance object.

Usage

modelPerformance_Report(x, projectLabel = "Model Performance",
  outFile = "./modelPerformance_Report.html", tempDir = ".tempDir")

Arguments

x	mt_modelPerformance object
projectLabel	character string; descriptive header for report
outFile	character string; file path/name for saving report (*.html)
tempDir	character string; temporary directory path

Value

No object is returned. The report is saved to the specified location.

See Also

modelPerformance, flex_dashboard

Examples

# pull in sample scored data frame
x <- modelSampleScored
str(x)
head(x)
# binary target
# create mt_modelPerformance object
# note that "v" and the "variableImportance..." parms are optional
# in case you do not have a validation set or do not know/care about the variable importance
z <- modelPerformance(
    y = x$TargetFlag,
    yhat = x$pTargetFlag,
    v = x$ValidateFlag
)
modelPerformance_Report(z)
# continuous target
z <- modelPerformance(
    y = x[x$TargetFlag, ]$TargetValue,
    yhat = x[x$TargetFlag, ]$pTargetValue,
    v = x[x$TargetFlag, ]$ValidateFlag,
    gainsChartBarGraph.yType = "dlr",
    gainsChartBarGraph.yDigits = 0
)
modelPerformance_Report(z)
# combined target (with arbitrary variable importance parms)
z <- modelPerformance(
    y = x$TargetFlag,
    yhat = x$pTargetFlag*x$pTargetValue,
    y2 = x$TargetValue,
    v = x$ValidateFlag,
    variableImportanceGraph.x = c(
        "Days Since Last Transaction",
        "Average Order Value",
        "Signed Up Online",
        "Number of Transactions",
        "Tenure",
        "Multi-Category Flag"
    ),
    variableImportanceGraph.y = c(.18, .4, .04, .25, .12, .01)
)
modelPerformance_Report(z)

dnegrey/miscTools documentation built on May 3, 2019, 2:57 p.m.