ks_score: KS score

View source: R/ks_score.R

ks_scoreR Documentation

KS score

Description

This function score (0-1000) a dataset with a binary classification model, also compute the KS score of the model.

Usage

ks_score(
  data,
  y,
  sample_col,
  model = NULL,
  score = NULL,
  return_data = TRUE,
  ks_precision = TRUE,
  quebras = NULL,
  score_var_name = "CON_stepKS_score",
  return_ks_num = NULL,
  subsample_data = 1,
  train_sample = "DES"
)

Arguments

data

R data frame object.

y

Name of you target column.

sample_col

Name of you sample column.

model

R model object.

score

Name of you score column.

return_data

If TRUE function will return the scored dataset.

ks_precision

If TRUE function will score your dataset before compute the KS Score.

quebras

If TRUE function will return quebras.

score_var_name

Name desired of computed score column.

return_ks_num

Name of you sample that the function you return the KS Score numeric.

subsample_data

Proportion of your data that fucntion will compute the KS Score.

train_sample

Name of you sample that you trained the model.

Value

scored dataset and the KS score.


jrgazola/stepKS documentation built on March 22, 2022, 12:06 a.m.