Type:	Package
Title:	Fast Machine Learning Model Training and Evaluation
Version:	0.7.0
Description:	Streamlines the training, evaluation, and comparison of multiple machine learning models with minimal code by providing comprehensive data preprocessing and support for a wide range of algorithms with hyperparameter tuning. It offers performance metrics and visualization tools to facilitate efficient and effective machine learning workflows.
Encoding:	UTF-8
License:	MIT + file LICENSE
URL:	https://selcukorkmaz.github.io/fastml-tutorial/, https://github.com/selcukorkmaz/fastml
BugReports:	https://github.com/selcukorkmaz/fastml/issues
Imports:	methods, recipes, dplyr, ggplot2, reshape2, rsample, parsnip, tune, workflows, yardstick, tibble, rlang, dials, RColorBrewer, baguette, bonsai, discrim, doFuture, finetune, future, plsmod, probably, viridisLite, DALEX, magrittr, pROC, janitor, stringr, DT, UpSetR, VIM, broom, dbscan, ggpubr, gridExtra, htmlwidgets, kableExtra, moments, naniar, plotly, scales, skimr, tidyr, tidyselect, purrr, mice, missForest, survival, flexsurv, rstpm2, iml, lime, survRM2, ceterisParibus, xgboost, knitr, rmarkdown
Suggests:	testthat (≥ 3.0.0), C50, ranger, aorsf, censored, crayon, kernlab, klaR, kknn, keras, lightgbm, rstanarm, mixOmics, pdp, patchwork, GGally, glmnet, agua, bslib, h2o, mlbench, tidyverse,
RoxygenNote:	7.3.2
Config/testthat/edition:	3
NeedsCompilation:	no
Packaged:	2025-10-29 19:08:23 UTC; selcukkorkmaz
Author:	Selcuk Korkmaz [aut, cre], Dincer Goksuluk [aut], Eda Karaismailoglu [aut]
Maintainer:	Selcuk Korkmaz <selcukorkmaz@gmail.com>
Repository:	CRAN
Date/Publication:	2025-10-29 19:40:07 UTC

Align Survival Curve to Evaluation Times

Description

Aligns a survival curve (defined by time points and survival probabilities) to a new set of evaluation times using constant interpolation (last value carried forward). Ensures S(0) = 1 and monotonicity.

Usage

align_survival_curve(curve_times, curve_surv, eval_times)

Arguments

Value

A numeric vector of survival probabilities at eval_times.

Assign Risk Groups

Description

Dichotomizes a continuous risk vector into "low" and "high" risk groups based on the median.

Usage

assign_risk_group(risk_vec)

Arguments

Value

A character vector of "low", "high", or NA.

Get Available Methods

Description

Returns a character vector of algorithm names available for classification, regression or survival tasks.

Usage

availableMethods(type = c("classification", "regression", "survival"), ...)

Arguments

Details

Depending on the specified type, the function returns a different set of algorithm names:

• For "classification", it returns algorithms such as "logistic_reg", "multinom_reg", "decision_tree", "C5_rules", "rand_forest", "xgboost", "lightgbm", "svm_linear", "svm_rbf", "nearest_neighbor", "naive_Bayes", "mlp", "discrim_linear", "discrim_quad", and "bag_tree".

• For "regression", it returns algorithms such as "linear_reg", "ridge_reg", "lasso_reg", "elastic_net", "decision_tree", "rand_forest", "xgboost", "lightgbm", "svm_linear", "svm_rbf", "nearest_neighbor", "mlp", "pls", and "bayes_glm".

• For "survival", it returns algorithms such as "rand_forest", "cox_ph", "penalized_cox", "stratified_cox", "time_varying_cox", "survreg", "royston_parmar", "parametric_surv", "piecewise_exp", and "xgboost".

Value

A character vector containing the names of the available algorithms for the specified task type.

Build Survival Matrix from survfit Object

Description

Extracts survival probabilities from a survfit object and aligns them to a common set of evaluation times, creating a matrix.

Usage

build_survfit_matrix(fit_obj, eval_times, n_obs)

Arguments

Value

A matrix (rows=subjects, cols=eval_times) of survival probabilities, or NULL on failure.

Clamp Values to [0, 1]

Description

Truncates a numeric vector so all values lie within the [0, 1] interval.

Usage

clamp01(x)

Arguments

Value

The clamped numeric vector.

Compute Integrated Brier Score and Curve

Description

Calculates the Brier score at specified evaluation times and the Integrated Brier Score (IBS) up to \tau, using IPCW to handle censoring.

Usage

compute_ibrier(eval_times, surv_mat, time_vec, status_vec, tau, censor_eval_fn)

Arguments

Value

A list with ibs (the scalar IBS value) and curve (a numeric vector of Brier scores at eval_times).

Compute Difference in Restricted Mean Survival Time (RMST)

Description

Calculates the difference in RMST between "low" and "high" risk groups up to a time horizon \tau. Groups are defined by median-splitting the risk_vec.

Usage

compute_rmst_difference(
  time_vec,
  status_vec,
  risk_vec,
  tau,
  surv_mat = NULL,
  eval_times_full = NULL,
  model_type = "other"
)

Arguments

Value

The RMST difference (RMST_low - RMST_high), or NA_real_.

Compute Survival Matrix from survreg Model

Description

Generates a matrix of survival probabilities (rows=subjects, cols=times) from a fitted survreg model for new data.

Usage

compute_survreg_matrix(fit_obj, new_data, eval_times)

Arguments

Value

A matrix of survival probabilities, or NULL on failure.

Compute Tau Limit (t_max)

Description

Finds the latest time point t_{max} such that at least a certain proportion of subjects remain at risk.

Usage

compute_tau_limit(times, threshold)

Arguments

Value

The computed t_{max} value, or NA_real_ if no valid times are provided.

Compute Uno's C-index (Time-Dependent AUC)

Description

Calculates Uno's C-index (a time-dependent AUC measure) for survival data, weighted by the inverse probability of censoring (IPCW).

Usage

compute_uno_c_index(
  train_time,
  train_status,
  test_time,
  test_status,
  risk_vec,
  tau,
  censor_eval_fn
)

Arguments

Value

The computed Uno's C-index, or NA_real_ on failure.

Convert Various Prediction Formats to Survival Matrix

Description

Attempts to convert various survival prediction formats (e.g., list of data frames from predict.model_fit with type "survival", matrices) into a standardized [n_obs, n_eval_times] matrix.

Usage

convert_survival_predictions(pred_obj, eval_times, n_obs)

Arguments

Value

A standardized matrix of survival probabilities, or NULL on failure.

Generate counterfactual explanations for a fastml model

Description

Uses the 'ceterisParibus' package to compute counterfactuals for a given observation.

Usage

counterfactual_explain(object, observation, ...)

Arguments

Value

A counterfactual explanation object.

Examples

## Not run: 
data(iris)
iris <- iris[iris$Species != "setosa", ]
iris$Species <- factor(iris$Species)
model <- fastml(data = iris, label = "Species")
counterfactual_explain(model, iris[1, ])

## End(Not run)

Create Censoring Distribution Evaluator

Description

Creates a function to evaluate the survival function of the censoring distribution, G(t) = P(C > t), using a Kaplan-Meier estimator.

Usage

create_censor_eval(time_vec, status_vec)

Arguments

Value

A function that takes a numeric vector of times and returns the estimated censoring survival probabilities G(t) at those times.

Determine rounding digits for time horizons

Description

Computes a sensible number of decimal digits to round time horizons based on the minimal positive separation between unique finite times.

Usage

determine_round_digits(times)

Arguments

Details

Uses the smallest strictly positive difference among sorted unique finite times, then returns ceiling(-log10(min_diff)) truncated to [0, 6].

Value

Integer number of digits between 0 and 6.

Examples

# Not run: determine_round_digits(c(0.1, 0.12, 0.125))
NULL

Evaluate Models Function

Description

Evaluates the trained models on the test data and computes performance metrics.

Usage

evaluate_models(
  models,
  train_data,
  test_data,
  label,
  start_col,
  time_col,
  status_col,
  task,
  metric = NULL,
  event_class,
  eval_times = NULL,
  bootstrap_ci = TRUE,
  bootstrap_samples = 500,
  bootstrap_seed = 1234,
  at_risk_threshold = 0.1
)

Arguments

Value

A list with two elements:

performance

A named list of performance metric tibbles for each model.

predictions

A named list of data frames with columns including truth, predictions, and probabilities per model.

Compute Accumulated Local Effects (ALE) for a fastml model

Description

Uses the 'iml' package to calculate ALE for the specified feature.

Usage

explain_ale(object, feature, ...)

Arguments

Value

An 'iml' object containing ALE results.

Examples

## Not run: 
data(iris)
iris <- iris[iris$Species != "setosa", ]
iris$Species <- factor(iris$Species)
model <- fastml(data = iris, label = "Species")
explain_ale(model, feature = "Sepal.Length")

## End(Not run)

Generate DALEX explanations for a fastml model

Description

Creates a DALEX explainer and computes permutation based variable importance, partial dependence (model profiles) and Shapley values.

Usage

explain_dalex(
  object,
  features = NULL,
  grid_size = 20,
  shap_sample = 5,
  vi_iterations = 10,
  seed = 123,
  loss_function = NULL
)

Arguments

Value

Invisibly returns a list with variable importance, optional model profiles and SHAP values.

Generate LIME explanations for a fastml model

Description

Creates a 'lime' explainer using the processed training data stored in the 'fastml' object and returns feature explanations for new observations.

Usage

explain_lime(object, n_features = 5, n_labels = 1, ...)

Arguments

Value

An object produced by 'lime::explain'.

Examples

## Not run: 
data(iris)
iris <- iris[iris$Species != "setosa", ]
iris$Species <- factor(iris$Species)
model <- fastml(data = iris, label = "Species")
explain_lime(model)

## End(Not run)

Extract survreg Linear Predictor and Scale

Description

Computes the linear predictor (lp) and scale parameter(s) for new data from a fitted survreg model.

Usage

extract_survreg_components(fit_obj, new_data)

Arguments

Value

A list with elements lp (numeric vector) and scale (numeric vector), or NULL on failure.

Explain a fastml model using various techniques

Description

Provides model explainability. When 'method = "dalex"' this function:

• Creates a DALEX explainer.

• Computes permutation-based variable importance with boxplots showing variability, displays the table and plot.

• Computes partial dependence-like model profiles if 'features' are provided.

• Computes Shapley values (SHAP) for a sample of the training observations, displays the SHAP table, and plots a summary bar chart of \text{mean}(\vert \text{SHAP value} \vert) per feature. For classification, it shows separate bars for each class.

Usage

fastexplain(
  object,
  method = "dalex",
  features = NULL,
  observation = NULL,
  grid_size = 20,
  shap_sample = 5,
  vi_iterations = 10,
  seed = 123,
  loss_function = NULL,
  ...
)

Arguments

Details

1. Custom number of permutations for VI (vi_iterations):

   You can now specify how many permutations (B) to use for permutation-based variable importance. More permutations yield more stable estimates but take longer.

2. Better error messages and checks:

   Improved checks and messages if certain packages or conditions are not met.

3. Loss Function:

   A loss_function argument has been added to let you pick a different performance measure (e.g., loss_cross_entropy for classification, loss_root_mean_square for regression).

4. Parallelization Suggestion:

Value

Prints DALEX explanations: variable importance table & plot, model profiles (if any), and SHAP table & summary plot.

Explore and Summarize a Dataset Quickly

Description

fastexplore provides a fast and comprehensive exploratory data analysis (EDA) workflow. It automatically detects variable types, checks for missing and duplicated data, suggests potential ID columns, and provides a variety of plots (histograms, boxplots, scatterplots, correlation heatmaps, etc.). It also includes optional outlier detection, normality testing, and feature engineering.

Usage

fastexplore(
  data,
  label = NULL,
  visualize = c("histogram", "boxplot", "barplot", "heatmap", "scatterplot"),
  save_results = TRUE,
  output_dir = NULL,
  sample_size = NULL,
  interactive = FALSE,
  corr_threshold = 0.9,
  auto_convert_numeric = TRUE,
  visualize_missing = TRUE,
  imputation_suggestions = FALSE,
  report_duplicate_details = TRUE,
  detect_near_duplicates = TRUE,
  auto_convert_dates = FALSE,
  feature_engineering = FALSE,
  outlier_method = c("iqr", "zscore", "dbscan", "lof"),
  run_distribution_checks = TRUE,
  normality_tests = c("shapiro"),
  pairwise_matrix = TRUE,
  max_scatter_cols = 5,
  grouped_plots = TRUE,
  use_upset_missing = TRUE
)

Arguments

Details

This function automates many steps of EDA:

1. Automatically detects numeric vs. categorical variables.

2. Auto-converts columns that look numeric (and optionally date-like).

3. Summarizes data structure, missingness, duplication, and potential ID columns.

4. Computes correlation matrix and flags highly correlated pairs.

5. (Optional) Outlier detection using IQR, Z-score, DBSCAN, or LOF methods.

6. (Optional) Normality tests on numeric columns.

7. Saves all results and an R Markdown report if save_results = TRUE.

Value

A (silent) list containing:

• data_overview - A basic overview (head, unique values, skim summary).

• summary_stats - Summary statistics for numeric columns.

• freq_tables - Frequency tables for factor columns.

• missing_data - Missing data overview (count, percentage).

• duplicated_rows - Count of duplicated rows.

• class_imbalance - Class distribution if label is provided and is categorical.

• correlation_matrix - The correlation matrix for numeric variables.

• zero_variance_cols - Columns with near-zero variance.

• potential_id_cols - Columns with unique values in every row.

• date_time_cols - Columns recognized as date/time.

• high_corr_pairs - Pairs of variables with correlation above corr_threshold.

• outlier_method - The chosen method for outlier detection.

• outlier_summary - Outlier proportions or metrics (if computed).

If save_results = TRUE, additional side effects include saving figures, a correlation heatmap, and an R Markdown report in the specified directory.

Fast Machine Learning Function

Description

Trains and evaluates multiple classification or regression models automatically detecting the task based on the target variable type.

Usage

fastml(
  data = NULL,
  train_data = NULL,
  test_data = NULL,
  label,
  algorithms = "all",
  task = "auto",
  test_size = 0.2,
  resampling_method = "cv",
  folds = ifelse(grepl("cv", resampling_method), 10, 25),
  repeats = ifelse(resampling_method == "repeatedcv", 1, NA),
  event_class = "first",
  exclude = NULL,
  recipe = NULL,
  tune_params = NULL,
  engine_params = list(),
  metric = NULL,
  algorithm_engines = NULL,
  n_cores = 1,
  stratify = TRUE,
  impute_method = "error",
  impute_custom_function = NULL,
  encode_categoricals = TRUE,
  scaling_methods = c("center", "scale"),
  balance_method = "none",
  resamples = NULL,
  summaryFunction = NULL,
  use_default_tuning = FALSE,
  tuning_strategy = "grid",
  tuning_iterations = 10,
  early_stopping = FALSE,
  adaptive = FALSE,
  learning_curve = FALSE,
  seed = 123,
  verbose = FALSE,
  eval_times = NULL,
  bootstrap_ci = TRUE,
  bootstrap_samples = 500,
  bootstrap_seed = NULL,
  at_risk_threshold = 0.1
)

Arguments

Details

Fast Machine Learning Function

Trains and evaluates multiple classification or regression models. The function automatically detects the task based on the target variable type and can perform advanced hyperparameter tuning using various tuning strategies.

Value

An object of class fastml containing the best model, performance metrics, and other information.

Examples

# Example 1: Using the iris dataset for binary classification (excluding 'setosa')
data(iris)
iris <- iris[iris$Species != "setosa", ]  # Binary classification
iris$Species <- factor(iris$Species)

# Define a custom tuning grid for the ranger engine
tune <- list(
  rand_forest = list(
    ranger = list(mtry = c(1, 3))
  )
)

# Train models with custom tuning
model <- fastml(
  data = iris,
  label = "Species",
  algorithms = "rand_forest",
  tune_params = tune,
  use_default_tuning = TRUE
)

# View model summary
summary(model)


  

Internal helpers for survival-specific preprocessing

Description

These utilities standardize survival status indicators so that downstream metrics always receive the conventional coding (0 = censored, 1 = event). The functions are intentionally unexported and are used across multiple internal modules. Normalize survival status coding to 0/1 representation

Usage

fastml_normalize_survival_status(status_vec, reference_length = NULL)

Arguments

Details

This helper attempts to coerce a status vector into a numeric format where 0 represents censoring and 1 represents the event indicator. It accepts a variety of common encodings such as 1/2, logical values, factors, or character labels. When the supplied values deviate from the canonical coding, the function records that a recode was performed so callers can communicate this to the user (once).

Value

A list with two elements: 'status', the recoded numeric vector, and 'recoded', a logical flag indicating whether a non-standard encoding was detected.

Flatten and Rename Models

Description

Flattens a nested list of models and renames the elements by combining the outer and inner list names.

Usage

flatten_and_rename_models(models)

Arguments

Details

The function iterates over each element of the outer list. For each element, if it is a list with names, the function concatenates the outer list name and the inner names using paste0 and setNames. If an element is not a list or does not have names, it is included in the result without modification.

Value

A flattened list with each element renamed according to its original outer and inner list names.

Framingham Heart Study Data

Description

This dataset is derived from the Framingham Heart Study and contains various clinical and demographic variables used to predict coronary heart disease risk over a ten-year period.

Format

male

Integer indicator for male sex.

age

Participant age in years.

education

Education level.

currentSmoker

Whether the participant currently smokes.

cigsPerDay

Number of cigarettes smoked per day.

BPMeds

Whether blood pressure medication is used.

prevalentStroke

History of stroke at baseline.

prevalentHyp

History of hypertension at baseline.

diabetes

Diabetes diagnosis.

totChol

Total cholesterol.

sysBP

Systolic blood pressure.

diaBP

Diastolic blood pressure.

BMI

Body mass index.

heartRate

Heart rate.

glucose

Glucose level.

TenYearCHD

Ten year risk of coronary heart disease.

Get Best Model Indices by Metric and Group

Description

Identifies and returns the indices of rows in a data frame where the specified metric reaches the overall maximum within groups defined by one or more columns.

Usage

get_best_model_idx(df, metric, group_cols = c("Model", "Engine"))

Arguments

Details

The function converts the metric values to numeric and creates a combined grouping factor using the specified group_cols. It then computes the maximum metric value within each group and determines the overall best metric value across the entire data frame. Finally, it returns the indices of rows belonging to groups that achieve this overall maximum.

Value

A numeric vector of row indices in df corresponding to groups whose maximum metric equals the overall best metric value.

Get Best Model Names

Description

Extracts and returns the best engine names from a named list of model workflows.

Usage

get_best_model_names(models)

Arguments

Details

For each algorithm, the function extracts the engine names from the model workflows using tune::extract_fit_parsnip. It then chooses "randomForest" if it is available; otherwise, it selects the first non-NA engine. If no engine names can be extracted for an algorithm, NA_character_ is returned.

Value

A named character vector. The names of the vector correspond to the algorithm names, and the values represent the chosen best engine name for that algorithm.

Get Best Workflows

Description

Extracts the best workflows from a nested list of model workflows based on the provided best model names.

Usage

get_best_workflows(models, best_model_name)

Arguments

Details

The function iterates over each element in best_model_name and attempts to extract the corresponding workflow from models using the specified engine. If the workflow for an algorithm-engine pair is not found, a warning is issued and NULL is returned for that entry.

Value

A named list of workflows corresponding to the best engine for each algorithm. Each list element is named in the format "algorithm (engine)".

Get Default Engine

Description

Returns the default engine corresponding to the specified algorithm.

Usage

get_default_engine(algo, task = NULL)

Arguments

Details

The function uses a switch statement to select the default engine based on the given algorithm. For survival random forests, the function defaults to "aorsf". If the provided algorithm does not have a defined default engine, the function terminates with an error.

Value

A character string containing the default engine name associated with the provided algorithm.

Get Default Parameters for an Algorithm

Description

Returns a list of default tuning parameters for the specified algorithm based on the task type, number of predictors, and engine.

Usage

get_default_params(algo, task, num_predictors = NULL, engine = NULL)

Arguments

Details

The function employs a switch statement to select and return a list of default parameters tailored for the given algorithm, task, and engine. The defaults vary by algorithm and, in some cases, by engine. For example:

• For "rand_forest", if engine is not provided, it defaults to "ranger". The parameters such as mtry, trees, and min_n are computed based on the task and the number of predictors.

• For "C5_rules", the defaults include trees, min_n, and sample_size.

• For "xgboost" and "lightgbm", default values are provided for parameters like tree depth, learning rate, and sample size.

• For "logistic_reg" and "multinom_reg", the function returns defaults for regularization parameters (penalty and mixture) that vary with the specified engine.

• For "decision_tree", the parameters (such as tree_depth, min_n, and cost_complexity) are set based on the engine (e.g., "rpart", "C5.0", "partykit", "spark").

• Other algorithms, including "svm_linear", "svm_rbf", "nearest_neighbor", "naive_Bayes", "mlp", "deep_learning", "elastic_net", "bayes_glm", "pls", "linear_reg", "ridge_reg", and "lasso_reg", have their respective default parameter lists.

Value

A list of default parameter settings for the specified algorithm. If the algorithm is not recognized, the function returns NULL.

Get Default Tuning Parameters

Description

Returns a list of default tuning parameter ranges for a specified algorithm based on the provided training data, outcome label, and engine.

Usage

get_default_tune_params(algo, train_data, label, engine)

Arguments

Details

The function first determines the number of predictors by removing the outcome variable (specified by label) from train_data. It then uses a switch statement to select a list of default tuning parameter ranges tailored for the specified algorithm and engine. The tuning ranges have been adjusted for efficiency and may include parameters such as mtry, trees, min_n, and others depending on the algorithm.

Value

A list of tuning parameter ranges for the specified algorithm. If no tuning parameters are defined for the given algorithm, the function returns NULL.

Get Engine Names from Model Workflows

Description

Extracts and returns a list of unique engine names from a list of model workflows.

Usage

get_engine_names(models)

Arguments

Details

The function applies tune::extract_fit_parsnip to each model workflow to extract the fitted model object. It then retrieves the engine name from the model specification (spec$engine). If the extraction fails, NA_character_ is returned for that workflow. Finally, the function removes any duplicate engine names using unique.

Value

A list of character vectors. Each vector contains the unique engine names extracted from the corresponding element of models.

Get Model Engine Names

Description

Extracts and returns a named vector mapping algorithm names to engine names from a nested list of model workflows.

Usage

get_model_engine_names(models)

Arguments

Details

The function iterates over a nested list of model workflows and, for each workflow, attempts to extract the fitted model object using tune::extract_fit_parsnip. If successful, it retrieves the algorithm name from the first element of the class attribute of the model specification and the engine name from the specification. The results are combined into a named vector.

Value

A named character vector where the names correspond to algorithm names (e.g., "rand_forest", "logistic_reg") and the values correspond to the associated engine names (e.g., "ranger", "glm").

Extract Time and Status from Survival Matrix

Description

Helper function to extract "time" and "status" columns from a matrix (like one returned by survival::Surv()), falling back to defaults.

Usage

get_surv_info(surv_matrix_vals, default_time, default_status)

Arguments

Value

A list with elements time and status.

Compute feature interaction strengths for a fastml model

Description

Uses the 'iml' package to quantify the strength of feature interactions.

Usage

interaction_strength(object, ...)

Arguments

Value

An 'iml::Interaction' object.

Examples

## Not run: 
data(iris)
iris <- iris[iris$Species != "setosa", ]
iris$Species <- factor(iris$Species)
model <- fastml(data = iris, label = "Species")
interaction_strength(model)

## End(Not run)

Load Model Function

Description

Loads a trained model object from a file.

Usage

load_model(filepath)

Arguments

Value

An object of class fastml.

Map Brier Curve Values to Specific Horizons

Description

Extracts Brier score values from a pre-computed curve at specific time horizons by finding the closest matching evaluation time.

Usage

map_brier_values(curve, eval_times, horizons)

Arguments

Value

A numeric vector of Brier scores corresponding to horizons.

Plot Methods for fastml Objects

Description

plot.fastml produces visual diagnostics for a trained fastml object.

Usage

## S3 method for class 'fastml'
plot(
  x,
  algorithm = "best",
  type = c("all", "bar", "roc", "calibration", "residual"),
  ...
)

Arguments

Details

When type = "all", plot.fastml will produce a bar plot of metrics, ROC curves (classification), calibration plot, and residual diagnostics (regression). If you specify a subset of types, only those will be drawn.

Examples

  ## Create a binary classification dataset from iris
  data(iris)
  iris <- iris[iris$Species != "setosa",]
  iris$Species <- factor(iris$Species)

  ## Fit fastml model on binary classification task
  model <- fastml(data = iris, label = "Species", algorithms = c("rand_forest", "svm_rbf"))

  ## 1. Plot all available diagnostics
  plot(model, type = "all")

  ## 2. Bar plot of performance metrics
  plot(model, type = "bar")

  ## 3. ROC curves (only for classification models)
  plot(model, type = "roc")

  ## 4. Calibration plot (requires 'probably' package)
  plot(model, type = "calibration")

  ## 5. ROC curves for specific algorithm(s) only
  plot(model, type = "roc", algorithm = "rand_forest")

  ## 6. Residual diagnostics (only available for regression tasks)
  model <- fastml(data = mtcars, label = "mpg", algorithms = c("linear_reg", "xgboost"))
  plot(model, type = "residual")

Plot ICE curves for a fastml model

Description

Generates Individual Conditional Expectation (ICE) plots for selected features using the 'pdp' package.

Usage

plot_ice(object, features, ...)

Arguments

Value

A 'ggplot' object displaying ICE curves.

Examples

## Not run: 
data(iris)
iris <- iris[iris$Species != "setosa", ]
iris$Species <- factor(iris$Species)
model <- fastml(data = iris, label = "Species")
plot_ice(model, features = "Sepal.Length")

## End(Not run)

Predict method for fastml objects

Description

Generates predictions from a trained 'fastml' object on new data. Supports both single-model and multi-model workflows, and handles classification and regression tasks with optional post-processing and verbosity.

Usage

## S3 method for class 'fastml'
predict(
  object,
  newdata,
  type = "auto",
  model_name = NULL,
  verbose = FALSE,
  postprocess_fn = NULL,
  eval_time = NULL,
  ...
)

Arguments

Value

A vector of predictions, or a named list of predictions (if multiple models are used). If 'postprocess_fn' is supplied, its output will be returned instead.

Examples

## Not run: 
  set.seed(123)
  model <- fastml(iris, label = "Species")
  test_data <- iris[sample(1:150, 20),-5]

  ## Best model(s) predictions
  preds <- predict(model, newdata = test_data)

  ## Predicted class probabilities using best model(s)
  probs <- predict(model, newdata = test_data, type = "prob")

  ## Prediction from a specific model by name
  single_model_preds <- predict(model, newdata = test_data, model_name = "rand_forest (ranger)")


## End(Not run)

Predict Risk Scores from a Survival Model

Description

Provides a consistent interface for computing linear predictors (risk scores) across various survival modeling engines, including native fastml models (e.g., Cox proportional hazards, XGBoost Cox) and parsnip/workflow objects.

Usage

predict_risk(fit, newdata, ...)

## S3 method for class 'fastml_native_survival'
predict_risk(fit, newdata, ...)

## S3 method for class 'workflow'
predict_risk(fit, newdata, ...)

## Default S3 method:
predict_risk(fit, newdata, ...)

Arguments

Value

A numeric vector of risk scores, where higher values indicate greater predicted risk.

Predict survival probabilities from a survival model

Description

Predict survival probabilities from a survival model

Usage

predict_survival(fit, newdata, times, ...)

## S3 method for class 'fastml_native_survival'
predict_survival(fit, newdata, times, ...)

## S3 method for class 'workflow'
predict_survival(fit, newdata, times, ...)

## Default S3 method:
predict_survival(fit, newdata, times, ...)

Arguments

Value

A numeric matrix with one row per observation and one column per time.

Process and Evaluate a Model Workflow

Description

This function processes a fitted model or a tuning result, finalizes the model if tuning was used, makes predictions on the test set, and computes performance metrics depending on the task type (classification or regression). It supports binary and multiclass classification, and handles probabilistic outputs when supported by the modeling engine.

Usage

process_model(
  model_obj,
  model_id,
  task,
  test_data,
  label,
  event_class,
  start_col = NULL,
  time_col = NULL,
  status_col = NULL,
  engine,
  train_data,
  metric,
  eval_times_user = NULL,
  bootstrap_ci = TRUE,
  bootstrap_samples = 500,
  bootstrap_seed = 1234,
  at_risk_threshold = 0.1
)

Arguments

Details

- If the input 'model_obj' is a 'tune_results' object, the function finalizes the model using the best hyperparameters according to the specified 'metric', and refits the model on the full training data.

- For classification tasks, performance metrics include accuracy, kappa, sensitivity, specificity, precision, F1-score, and ROC AUC (if probabilities are available).

- For regression tasks, RMSE, R-squared, and MAE are returned.

- For models with missing prediction lengths, a helpful imputation error is thrown to guide data preprocessing.

Value

A list with two elements:

performance

A tibble with computed performance metrics.

predictions

A tibble with predicted values and corresponding truth values, and probabilities (if applicable).

Clean Column Names or Character Vectors by Removing Special Characters

Description

This function can operate on either a data frame or a character vector:

• Data frame: Detects columns whose names contain any character that is not a letter, number, or underscore, removes colons, replaces slashes with underscores, and spaces with underscores.

• Character vector: Applies the same cleaning rules to every element of the vector.

Usage

sanitize(x)

Arguments

Value

• If x is a data frame: returns a data frame with cleaned column names.

• If x is a character vector: returns a character vector with cleaned elements.

Save Model Function

Description

Saves the trained model object to a file.

Usage

save.fastml(model, filepath)

Arguments

Value

No return value, called for its side effect of saving the model object to a file.

Summary Function for fastml (Using yardstick for ROC Curves)

Description

Summarizes the results of machine learning models trained using the 'fastml' package. Depending on the task type (classification or regression), it provides customized output such as performance metrics, best hyperparameter settings, and confusion matrices. It is designed to be informative and readable, helping users quickly interpret model results.

Usage

## S3 method for class 'fastml'
summary(
  object,
  algorithm = "best",
  type = c("all", "metrics", "params", "conf_mat"),
  sort_metric = NULL,
  show_ci = FALSE,
  brier_times = NULL,
  ...
)

Arguments

Details

For classification tasks, the summary includes metrics such as Accuracy, F1 Score, Kappa, Precision, ROC AUC, Sensitivity, and Specificity. A confusion matrix is also provided for the best model(s). For regression tasks, the summary reports RMSE, R-squared, and MAE.

Users can control the type of output with the 'type' argument: 'metrics' displays model performance metrics. 'params' shows the best hyperparameter settings. 'conf_mat' prints confusion matrices (only for classification). 'all' includes all of the above.

If multiple algorithms are trained, the summary highlights the best model based on the optimized metric. For survival tasks, Harrell's C-index, Uno's C-index, the integrated Brier score, and (when available) the RMST difference are shown by default. Specific Brier(t) horizons can be requested through the brier_times argument.

Value

Prints summary of fastml models.

Fit a surrogate decision tree for a fastml model

Description

Builds an interpretable tree approximating the behaviour of the underlying model using the 'iml' package.

Usage

surrogate_tree(object, maxdepth = 3, ...)

Arguments

Value

An 'iml::TreeSurrogate' object.

Examples

## Not run: 
data(iris)
iris <- iris[iris$Species != "setosa", ]
iris$Species <- factor(iris$Species)
model <- fastml(data = iris, label = "Species")
surrogate_tree(model)

## End(Not run)

Train Specified Machine Learning Algorithms on the Training Data

Description

Trains specified machine learning algorithms on the preprocessed training data.

Usage

train_models(
  train_data,
  label,
  task,
  algorithms,
  resampling_method,
  folds,
  repeats,
  resamples = NULL,
  tune_params,
  engine_params = list(),
  metric,
  summaryFunction = NULL,
  seed = 123,
  recipe,
  use_default_tuning = FALSE,
  tuning_strategy = "grid",
  tuning_iterations = 10,
  early_stopping = FALSE,
  adaptive = FALSE,
  algorithm_engines = NULL
)

Arguments

Value

A list of trained model objects.