shared_eval_lib_args: Arguments that are shared by multiple 'Evaluator' library...

In Yu-Group/simChef: Intensive Computational Experiments Made Easy

Arguments that are shared by multiple Evaluator library functions.

Description

Arguments that are shared by multiple Evaluator library functions.

Arguments

custom_summary_funs	Named list of custom functions to summarize results. Names in the list should correspond to the name of the summary function. Values in the list should be a function that takes in one argument, that being the values of the evaluated metrics.
curve	Either "ROC" or "PR" indicating whether to evaluate the ROC or Precision-Recall curve.
eval_id	Character string. ID to be used as a suffix when naming result columns. Default NULL does not add any ID to the column names.
feature_col	A character string identifying the column in fit_results with the feature names or IDs.
group_cols	(Optional) A character string or vector specifying the column(s) to group rows by before evaluating metrics. This is useful for assessing within-group metrics.
na_rm	A logical value indicating whether NA values should be stripped before the computation proceeds.
nested_cols	(Optional) A character string or vector specifying the name of the column(s) in fit_results that need to be unnested before evaluating results. Default is NULL, meaning no columns in fit_results need to be unnested prior to computation.
summary_funs	Character vector specifying how to summarize evaluation metrics. Must choose from a built-in library of summary functions - elements of the vector must be one of "mean", "median", "min", "max", "sd", "raw".
x_grid	Vector of values between 0 and 1 at which to evaluate the ROC or PR curve. If curve = "ROC", the provided vector of values are the FPR values at which to evaluate the TPR, and if curve = "PR", the values are the recall values at which to evaluate the precision.

Yu-Group/simChef documentation built on March 25, 2024, 3:22 a.m.