score_predictors {ppsr}

Calculate predictive power scores for y Calculates the predictive power scores for the specified y variable using every column in the dataset as x, including itself.

Description

Calculate predictive power scores for y Calculates the predictive power scores for the specified y variable using every column in the dataset as x, including itself.

Usage

score_predictors(df, y, ..., do_parallel = FALSE, n_cores = -1)

Arguments

df

data.frame containing columns for x and y

y

string, column name of target variable

...

any arguments passed to score

do_parallel

bool, whether to perform score calls in parallel

n_cores

numeric, number of cores to use, defaults to maximum minus 1

Value

a data.frame containing

x

the name of the predictor variable

y

the name of the target variable

result_type

text showing how to interpret the resulting score

pps

the predictive power score

metric

the evaluation metric used to compute the PPS

baseline_score

the score of a naive model on the evaluation metric

model_score

the score of the predictive model on the evaluation metric

cv_folds

how many cross-validation folds were used

seed

the seed that was set

algorithm

text shwoing what algorithm was used

model_type

text showing whether classification or regression was used

Examples

score_predictors(df = iris, y = 'Species')
score_predictors(df = mtcars, y = 'mpg', do_parallel = TRUE, n_cores = 2)