ModelInsightsReport: ModelInsightsReport

In AdrianAntico/ModelingTools: AutoQuant

ModelInsightsReport

Description

ModelInsightsReport is an Rmarkdown report for viewing the model insights generated by AutoQuant supervised learning functions

Usage

ModelInsightsReport(
  TrainDataInclude = FALSE,
  FeatureColumnNames = NULL,
  SampleSize = 1e+05,
  ModelObject = NULL,
  ModelID = "ModelTest",
  SourcePath = NULL,
  OutputPath = NULL,
  KeepOutput = NULL,
  GlobalVars = ls()
)

Arguments

TrainDataInclude	Default FALSE. If FALSE, no derived visuals or metrics for TrainData
FeatureColumnNames	NULL. Feature column names as character vector.
SampleSize	Default 100000
ModelObject	Returned output from regression, classificaiton, and multiclass Remix Auto_() models. Currenly supports CatBoost, XGBoost, and LightGBM models
ModelID	ModelID used in the AutoQuant supervised learning function
SourcePath	Path to directory with AutoQuant Model Output
OutputPath	Path to directory where the html will be saved
KeepOutput	NULL A list of output names to select. Pass in as a character vector. E.g. c('Test_VariableImportance', 'Train_VariableImportance')
GlobalVars	ls() don't use

Author(s)

Adrian Antico

AdrianAntico/ModelingTools documentation built on June 10, 2025, 1:17 a.m.