Functional Machine Learning Framework

Documentation for package ‘funcml’ version 0.7.1

Help Pages

-- A --

accuracy	Regression and classification metrics.
arthritis	Arthritis survey data
auc	Regression and classification metrics.
auc_weighted	Regression and classification metrics.

-- B --

balanced_accuracy	Regression and classification metrics.
bangladeshmaternalrisk	Bangladesh maternal risk data
birthweight	Birth weight data
breastcancerdiagnostic	Breast cancer diagnostic data
breastcancerwisconsin	Wisconsin breast cancer data
brier	Regression and classification metrics.

-- C --

calibration_curve	Regression and classification metrics.
cancerremission	Cancer remission data
cd4counts	CD4 follow-up data
cigsmoke	Youth tobacco survey data
coef.funcml_fit	Methods for fitted funcml models.
compare-methods	Methods for learner comparison results.
compare_learners	Compare multiple learners with optional tuning.
cv	Resampling specification generator.

-- D --

doctorvisits

Doctor visits data

-- E --

ece	Regression and classification metrics.
estimate	Causal effect estimation via plug-in g-computation.
estimate-methods	Methods for causal estimand results.
evaluate	Cross-validated evaluation.
evaluate-methods	Methods for cross-validation results.

-- F --

f1	Regression and classification metrics.
fit	Fit a model using the funcml interface.
fit-methods	Methods for fitted funcml models.

-- G --

group_cv

Grouped cross-validation.

-- H --

haberman	Haberman survival data
heartdisease	Heart disease patient data
heartfailure	Heart failure data
holdout	Plain holdout resampling.

-- I --

infantmortality	Infant mortality data
interpret	Model-agnostic interpretation (global + local).
interpret-ale-methods	ALE result methods.
interpret-calibration-methods	Calibration result methods.
interpret-ice-methods	ICE result methods.
interpret-interaction-methods	Interaction result methods.
interpret-local-methods	Local surrogate result methods.
interpret-local-model-methods	Local surrogate result methods for 'local_model' and 'lime'.
interpret-pdp-methods	Partial dependence result methods.
interpret-permute-methods	Permutation importance result methods.
interpret-shap-methods	SHAP result methods.
interpret-surrogate-methods	Global surrogate result methods.

-- K --

ketapain

Ketamine pain management data

-- L --

learners	Available learners.
list_interpretability_methods	List available interpretability methods.
list_learners	Learner inventory table with capabilities.
list_metrics	List available metrics used in scoring and resampling summaries.
list_tunable_learners	Shortcut for learners with tuning support.
logloss	Regression and classification metrics.

-- M --

mae	Regression and classification metrics.
mammography	Mammography calcification data
mape	Regression and classification metrics.
mce	Regression and classification metrics.
medae	Regression and classification metrics.
metrics	Regression and classification metrics.
mse	Regression and classification metrics.

-- N --

newthyroid

Thyroid function data

-- P --

pimadiabetes	Pima diabetes data
plot.funcml_ale	ALE result methods.
plot.funcml_calibration	Calibration result methods.
plot.funcml_compare	Methods for learner comparison results.
plot.funcml_estimand	Methods for causal estimand results.
plot.funcml_eval	Methods for cross-validation results.
plot.funcml_ice	ICE result methods.
plot.funcml_iml_local_model	Local surrogate result methods for 'local_model' and 'lime'.
plot.funcml_interaction	Interaction result methods.
plot.funcml_lime	Local surrogate result methods for 'local_model' and 'lime'.
plot.funcml_local	Local surrogate result methods.
plot.funcml_pdp	Partial dependence result methods.
plot.funcml_permute	Permutation importance result methods.
plot.funcml_shap	SHAP result methods.
plot.funcml_surrogate	Global surrogate result methods.
plot.funcml_tune	Methods for tuning results.
precision	Regression and classification metrics.
predict.funcml_fit	Methods for fitted funcml models.
print.funcml_ale	ALE result methods.
print.funcml_calibration	Calibration result methods.
print.funcml_compare	Methods for learner comparison results.
print.funcml_estimand	Methods for causal estimand results.
print.funcml_eval	Methods for cross-validation results.
print.funcml_fit	Methods for fitted funcml models.
print.funcml_ice	ICE result methods.
print.funcml_iml_local_model	Local surrogate result methods for 'local_model' and 'lime'.
print.funcml_interaction	Interaction result methods.
print.funcml_local	Local surrogate result methods.
print.funcml_pdp	Partial dependence result methods.
print.funcml_permute	Permutation importance result methods.
print.funcml_shap	SHAP result methods.
print.funcml_surrogate	Global surrogate result methods.
print.funcml_tune	Methods for tuning results.

-- R --

recall	Regression and classification metrics.
rmse	Regression and classification metrics.
rsq	Regression and classification metrics.

-- S --

specificity	Regression and classification metrics.
summary.funcml_ale	ALE result methods.
summary.funcml_calibration	Calibration result methods.
summary.funcml_compare	Methods for learner comparison results.
summary.funcml_estimand	Methods for causal estimand results.
summary.funcml_eval	Methods for cross-validation results.
summary.funcml_fit	Methods for fitted funcml models.
summary.funcml_ice	ICE result methods.
summary.funcml_iml_local_model	Local surrogate result methods for 'local_model' and 'lime'.
summary.funcml_interaction	Interaction result methods.
summary.funcml_local	Local surrogate result methods.
summary.funcml_pdp	Partial dependence result methods.
summary.funcml_permute	Permutation importance result methods.
summary.funcml_shap	SHAP result methods.
summary.funcml_surrogate	Global surrogate result methods.
summary.funcml_tune	Methods for tuning results.

-- T --

theme_funcml	FuncML plotting theme.
time_cv	Time-aware rolling resampling.
tune	Hyperparameter tuning via grid or random search.
tune-methods	Methods for tuning results.