Unified Predictive Modeling Toolkit


[Up] [Top]

Documentation for package ‘uniml’ version 0.5.1

Help Pages

A B C D E F G H I L M N P R S T U V W

-- A --

apply_balance Apply a fitted class-balancing step
apply_balance.default Apply a fitted class-balancing step
apply_balance.uniml_step_balance Apply a fitted class-balancing step
apply_encode Apply a fitted encoding step
apply_encode.default Apply a fitted encoding step
apply_encode.uniml_step_encode Apply a fitted encoding step
apply_imputer Apply an imputation step
apply_imputer.default Apply an imputation step
apply_imputer.uniml_step_impute Apply an imputation step
apply_preprocessor Apply a fitted preprocessing pipeline
apply_scale Apply a fitted scaling step
apply_scale.default Apply a fitted scaling step
apply_scale.uniml_step_scale Apply a fitted scaling step
apply_step Apply a single preprocessing step
apply_step.default Apply a single preprocessing step
apply_step.uniml_step_balance Apply a single preprocessing step
apply_step.uniml_step_encode Apply a single preprocessing step
apply_step.uniml_step_impute Apply a single preprocessing step
apply_step.uniml_step_scale Apply a single preprocessing step
assemble_result Assemble a complete uniml result
as_uniml_binary Convert an mlr3 prediction into a 'uniml_binary' object
as_uniml_data Convert data to a uniml data object
as_uniml_multiclass Convert an mlr3 prediction into a 'uniml_multiclass' object

-- B --

balance_classes Balance class frequencies

-- C --

calc_ci Bootstrap confidence intervals for binary metrics
calc_metrics Calculate binary classification metrics
calc_metrics.data.frame Calculate binary classification metrics
calc_metrics.default Calculate binary classification metrics
calc_metrics.matrix Calculate binary classification metrics
calc_metrics.numeric Calculate binary classification metrics
calc_metrics.PredictionClassif Calculate binary classification metrics
calc_metrics.uniml_binary Calculate binary classification metrics
calc_metrics.uniml_multiclass Calculate binary classification metrics
calc_nri_idi Calculate continuous or categorical NRI and IDI
calibrate_probabilities Calibrate predicted probabilities
calibrate_probabilities.default Calibrate predicted probabilities
calibrate_probabilities.matrix Calibrate predicted probabilities
calibrate_probabilities.numeric Calibrate predicted probabilities
calibrate_probabilities.uniml_binary Calibrate predicted probabilities
calibrate_probabilities.uniml_multiclass Calibrate multiclass probabilities by temperature scaling
calibration_metrics Calibration intercept and slope
combine_selections Combine feature-selection results

-- D --

dca Decision-curve analysis
dca.default Decision-curve analysis
dca.numeric Decision-curve analysis
dca.uniml_binary Decision-curve analysis
delong_test Compare binary model AUCs with DeLong tests
detect_var_types Detect feature variable types
diagnose_missing Diagnose missing values

-- E --

encode_categorical Encode categorical variables
explain_shap Compute SHAP explanations
explain_shap.default Compute SHAP explanations
explain_shap.Learner Compute SHAP explanations
explain_shap.list Compute SHAP explanations
explain_shap.uniml_binary Compute SHAP explanations
explain_shap.uniml_result Compute SHAP explanations
export_results Export a uniml result
extract_thresholds Extract SHAP-zero clinical thresholds

-- F --

find_threshold Find a binary classification threshold
fit_balance Fit a class-balancing step
fit_encode Fit a categorical encoding step
fit_imputer Fit an imputer
fit_preprocessor Fit a preprocessing pipeline
fit_scale Fit a numeric scaling step

-- G --

get_task_type Get a task-type descriptor

-- H --

hl_test Hosmer-Lemeshow goodness-of-fit test

-- I --

impute_data Impute missing values

-- L --

list_task_types List registered task types

-- M --

make_split Split uniml data into train, validation, and optional test sets
make_task Build an mlr3 classification task
multiclass_calibration Calibration of a multiclass model

-- N --

new_uniml_result Construct a uniml result container

-- P --

plot.uniml_result Plot a uniml result
plot_calibration Plot probability-calibration curves
plot_calibration.data.frame Plot probability-calibration curves
plot_calibration.PredictionClassif Plot probability-calibration curves
plot_calibration.uniml_binary Plot probability-calibration curves
plot_calibration.uniml_multiclass Plot probability-calibration curves
plot_calibration.uniml_result Plot probability-calibration curves
plot_confusion Plot confusion-matrix heatmaps
plot_confusion.data.frame Plot confusion-matrix heatmaps
plot_confusion.PredictionClassif Plot confusion-matrix heatmaps
plot_confusion.uniml_binary Plot confusion-matrix heatmaps
plot_confusion.uniml_multiclass Plot confusion-matrix heatmaps
plot_confusion.uniml_result Plot confusion-matrix heatmaps
plot_dca Plot decision curves
plot_dca.uniml_binary Plot decision curves
plot_dca.uniml_dca Plot decision curves
plot_dca.uniml_multiclass Plot decision curves
plot_dca.uniml_result Plot decision curves
plot_pr_curve Plot precision-recall curves
plot_pr_curve.data.frame Plot precision-recall curves
plot_pr_curve.PredictionClassif Plot precision-recall curves
plot_pr_curve.uniml_binary Plot precision-recall curves
plot_pr_curve.uniml_result Plot precision-recall curves
plot_roc Plot ROC curves
plot_roc.data.frame Plot ROC curves
plot_roc.PredictionClassif Plot ROC curves
plot_roc.uniml_binary Plot ROC curves
plot_roc.uniml_multiclass Plot ROC curves
plot_roc.uniml_result Plot ROC curves
plot_shap_beeswarm Plot a SHAP beeswarm
plot_shap_beeswarm.mshapviz Plot a SHAP beeswarm
plot_shap_beeswarm.shapviz Plot a SHAP beeswarm
plot_shap_beeswarm.uniml_binary Plot a SHAP beeswarm
plot_shap_beeswarm.uniml_result Plot a SHAP beeswarm
plot_shap_dependence Plot a SHAP dependence curve
plot_shap_dependence.mshapviz Plot a SHAP dependence curve
plot_shap_dependence.shapviz Plot a SHAP dependence curve
plot_shap_dependence.uniml_binary Plot a SHAP dependence curve
plot_shap_dependence.uniml_result Plot a SHAP dependence curve
plot_shap_force Plot a single-observation SHAP force plot
plot_shap_force.mshapviz Plot a single-observation SHAP force plot
plot_shap_force.shapviz Plot a single-observation SHAP force plot
plot_shap_force.uniml_binary Plot a single-observation SHAP force plot
plot_shap_force.uniml_result Plot a single-observation SHAP force plot
plot_shap_importance Plot SHAP importance
plot_shap_importance.mshapviz Plot SHAP importance
plot_shap_importance.shapviz Plot SHAP importance
plot_shap_importance.uniml_binary Plot SHAP importance
plot_shap_importance.uniml_result Plot SHAP importance
plot_shap_waterfall Plot a single-observation SHAP waterfall
plot_shap_waterfall.mshapviz Plot a single-observation SHAP waterfall
plot_shap_waterfall.shapviz Plot a single-observation SHAP waterfall
plot_shap_waterfall.uniml_binary Plot a single-observation SHAP waterfall
plot_shap_waterfall.uniml_result Plot a single-observation SHAP waterfall
pool_mi Pool estimates across multiple imputations (strict Rubin's rules)
predict.uniml_result Predict with a fitted uniml workflow
predict_uniml Predict with a fitted uniml workflow
print.uniml_calibration Print a fitted calibration
print.uniml_data Print a uniml data object
print.uniml_preprocessor Print a uniml preprocessor
print.uniml_result Print a uniml result
print.uniml_shap Print a SHAP result
print.uniml_spec Print a uniml specification
print.uniml_split Print a uniml split
print.uniml_task_type Print a task-type descriptor

-- R --

rank_models Rank models on a comparison set
read_result Save and read a fitted result
register_learner Register a learner for use by 'resolve_learners()'
register_task_type Register a task type
register_workflow_adapter Register a workflow adapter for a task type
remove_collinear Remove collinear features
resolve_learners Resolve learners from a uniml specification
run_workflow Run a complete uniml workflow

-- S --

save_result Save and read a fitted result
scale_numeric Scale numeric variables
select_boruta Select features with Boruta
select_features Run feature selection from a uniml specification
select_lasso Select features with LASSO
select_multivariate Select features with multivariable logistic regression
select_rfe Select features with recursive feature elimination
select_rf_importance Select features with random-forest importance
select_univariate Select features with univariable logistic regression
set_evaluation Set evaluation options
set_explain Set explanation options
set_feature_selection Set feature-selection options
set_labels Set display labels
set_leakage_policy Set the data-leakage policy
set_learners Set learners
set_output Set output options
set_preprocess Set preprocessing options
set_tuning Set tuning options
summary.uniml_result Summarise a uniml result

-- T --

task_type_spec Task-type descriptor
theme_uniml Unified plotting theme
train_model Train a final classification model
tripod_ai_check Audit a result against the TRIPOD+AI reporting domains
tune_model Tune an mlr3 learner

-- U --

uniml_spec Construct a uniml specification

-- V --

validate_uniml_data Validate a uniml data object
validate_uniml_preprocessor Validate a uniml preprocessor
validate_uniml_result Validate a uniml result
validate_uniml_spec Validate a uniml specification
validate_uniml_split Validate a uniml split
validate_uniml_task_type Validate a task-type descriptor

-- W --

workflow_adapter Get the workflow adapter of a task type
workflow_engine Fit a task type's models and predict the evaluation sets