Package 'manydist'

Description

Construct a tibble of valid method specifications that can be passed to [benchmark_mdist()] or iterated over manually to benchmark [mdist()] across multiple configurations.

Usage

all_dist_method_specs(
  mode = c("full", "presets_only", "response_aware_only"),
  method_cat = NULL,
  method_num = NULL,
  preset = NULL,
  commensurable = NULL
)

Arguments

Details

The resulting tibble combines preset-based specifications and custom custom specifications built from the currently available categorical methods and numerical preprocessing options listed in [dist_methods_tbl()].

Rows with 'preset = "custom"' use the explicit categorical, numerical, and commensurability options. Named presets determine those settings internally.

'mode' defines the initial candidate pool. Any explicit argument filters supplied by the user are applied afterwards and therefore restrict the selected pool further.

With 'mode = "response_aware_only"', preset specifications and categorical methods are restricted to response-aware methods.

Value

A tibble where each row represents one valid 'mdist()' specification. The tibble contains 'preset', 'method_cat', 'method_num', and 'commensurable'.

Examples

all_dist_method_specs()
all_dist_method_specs(mode = "presets_only")
all_dist_method_specs(mode = "response_aware_only")
all_dist_method_specs(mode = "full", method_cat = c("tvd", "le_and_ho"))

Description

Draws an annotated triangular heatmap of the pairwise diagnostics from [benchmark_mdist()].

Usage

## S3 method for class 'MDistBenchmark'
autoplot(
  object,
  metric = c("relative_distance", "mad", "alienation", "mds_congruence", "ari"),
  cluster_method = NULL,
  digits = 2,
  ...
)

Arguments

Details

The default fill gradient runs from coral ('#E76F51') for lower values to blue ('#008CFF') for higher values, with regular-weight white cell labels. To use another palette, add a fill scale to the returned plot. Self-comparisons on the main diagonal are left blank. ARI plots use fixed colour limits of 0 and 1, so the same ARI has the same colour across plots. Negative ARIs retain their numerical labels but use the low-end colour.

Value

A 'ggplot' object.

Description

Applies [mdist()] repeatedly over a tibble of distance-method specifications, typically generated with [all_dist_method_specs()]. It then compares every pair of successful distance specifications using distance, configuration, and optional clustering diagnostics.

Usage

benchmark_mdist(
  x,
  response = NULL,
  specs = all_dist_method_specs(),
  dims = 2,
  cluster_k = NULL,
  cluster_methods = c("pam", "hclust", "spectral"),
  hclust_method = "average",
  spectral_sigma = NULL,
  spectral_nstart = 50
)

Arguments

Details

Each row of 'specs' is interpreted as one valid 'mdist()' configuration. Preset-based and custom specifications are both supported. Failed specifications are caught and returned in the output rather than stopping the full benchmark.

Preset specifications use the 'preset' column and ignore 'method_cat', 'method_num', and 'commensurable'. Component specifications are evaluated as 'preset = "custom"' and use 'method_cat', 'method_num', and 'commensurable'.

Pairwise mean absolute difference ('mad') is computed from the lower triangle of each dissimilarity matrix. The symmetric relative distance is defined as

$\frac{2\,\mathrm{mean}(|d_a-d_b|)} {\mathrm{mean}(|d_a|)+\mathrm{mean}(|d_b|)}.$

Classical multidimensional scaling configurations are compared using [congruence_coeff()]. The corresponding alienation coefficient is $\sqrt{1-c^2}$.

When 'cluster_k' is supplied, each requested clustering method is applied once to every successful distance specification. Partitions produced by the same clustering method are then compared pairwise using the adjusted Rand index. When 'cluster_k = NULL', no clustering is performed and no ARI columns are included in the comparisons.

Value

An object of class '"MDistBenchmark"', which is also a tibble. It contains the supplied specifications together with:

result

The corresponding output of [mdist()], or an error object if the specification failed.

ok

Logical indicator; 'TRUE' if the run completed successfully, 'FALSE' otherwise.

error

Error message for failed runs, 'NA' otherwise.

Use 'summary()' to display and obtain the complete pairwise-diagnostics tibble, and [ggplot2::autoplot()] to draw an annotated triangular heatmap. The default print method displays a compact run overview; use 'tibble::as_tibble()' to inspect the complete underlying run table.

Examples

if (requireNamespace("palmerpenguins", quietly = TRUE)) {
  data("penguins", package = "palmerpenguins")

  penguins_small <- palmerpenguins::penguins |>
    dplyr::select(
      species, bill_length_mm, bill_depth_mm, flipper_length_mm,
      body_mass_g, island, sex
    ) |>
    tidyr::drop_na()

  specs <- all_dist_method_specs(
    mode = "presets_only",
    preset = c("gower", "u_indep", "u_dep")
  )

  res <- benchmark_mdist(
    penguins_small,
    response = species,
    specs = specs
  )

  res
  pairwise_results <- summary(res)
  ggplot2::autoplot(res, metric = "relative_distance")
}

Description

This function compares **leave-one-variable-out (LOVO)** diagnostics across multiple distance definitions supported by manydist.

Usage

compare_lovo_mdist(
  x,
  methods,
  mds = FALSE,
  dims = 2,
  keep_dist = FALSE,
  .progress = FALSE,
  ...
)

Arguments

methods = list(
  gower = list(preset = "gower"),
  u_dep = list(preset = "unbiased_dependent"),
  custom = list(
    preset = "custom",
    method_cat = "matching",
    method_num = "std",
    commensurable = TRUE
  )
)

Details

For each distance specification, the function:

1. Computes the full mixed-type distance using mdist().

2. Recomputes the distance repeatedly leaving out one variable at a time.

3. Measures the impact of each variable using mean absolute deviation (MAD) and, when requested, MDS- or clustering-based diagnostics.

The results are combined across methods and returned as an MDistLOVOCompare object, which supports print(), summary(), and ggplot2::autoplot().

In autoplot(), reorder = TRUE ranks variables by the selected metric averaged across methods, separately within each variable type. Categorical variables precede numerical variables, preserving the blue/red background bands. top_n still selects variables globally before ordering. If type information is absent, ordering is global.

Value

An object of class MDistLOVOCompare containing:

results

A tibble with one row per method-variable combination.

methods

The list of distance specifications used.

mds

Whether MDS diagnostics were computed.

dims

Number of MDS dimensions used, or 'NULL' when 'mds = FALSE'.

n_obs

Number of observations in the dataset.

See Also

lovo_mdist, mdist

Examples

## Not run: 
library(manydist)
library(palmerpenguins)

data <- penguins |>
  dplyr::select(-species) |>
  tidyr::drop_na()

cmp <- compare_lovo_mdist(
  x = data,
  methods = list(
    gower = list(preset = "gower"),
    u_dep = list(preset = "unbiased_dependent")
  ),
  cluster_k = 3
)

summary(cmp)
autoplot(cmp, metric = "mad_importance")
autoplot(cmp, metric = "pam_importance")

## End(Not run)

Description

Computes the congruence coefficient between two data configurations using the Frobenius inner product of their pairwise distance matrices.

Usage

congruence_coeff(L1, L2)

Arguments

Details

The congruence coefficient is defined as

$\frac{\langle D_1, D_2 \rangle_F} {\sqrt{\langle D_1, D_1 \rangle_F \langle D_2, D_2 \rangle_F}}$

where $D_1$ and $D_2$ are the pairwise distance matrices derived from L1 and L2.

Value

A scalar in $[-1,1]$ measuring similarity between the two configurations.

Description

Returns a tibble describing the categorical methods, numerical preprocessing options, and preset specifications currently available in 'manydist'.

Usage

dist_methods_tbl()

Details

The table is used by helpers such as [all_dist_method_specs()] and [benchmark_mdist()] to construct valid 'mdist()' specifications.

Value

A tibble with one row per available method. The columns are:

method

Name of the method or preset.

argument

The 'mdist()' argument to which the method belongs: '"method_cat"', '"method_num"', or '"preset"'.

data_type

Type of variables targeted by the method.

distance_basis

Broad methodological family.

response_aware

Logical; whether the method can use a response variable.

engine

Implementation source.

Examples

dist_methods_tbl()

dist_methods_tbl() |>
  dplyr::count(argument)

Description

Convenience wrapper around [dist_methods_tbl()] returning only methods that can be used as categorical dissimilarities through 'method_cat'.

Usage

dist_methods_tbl_cat()

Value

A tibble containing the rows of [dist_methods_tbl()] with 'argument == "method_cat"'.

Examples

dist_methods_tbl_cat()

Description

The fifa_nl dataset contains information on players in the Dutch League from the FIFA 21 video game. This dataset includes various attributes of players, such as demographics, club details, skill ratings, and physical characteristics.

Usage

data("fifa_nl")

Format

A data frame with observations on various attributes describing the players.

player_positions

Primary playing positions of the player.

nationality

The country the player represents.

team_position

Player's assigned position within their club.

club_name

Name of the club the player is part of.

work_rate

The player's work rate, describing defensive and attacking intensity.

weak_foot

Skill rating for the player's non-dominant foot, ranging from 1 to 5.

skill_moves

Skill moves rating, indicating technical skill and ability to perform complex moves, on a scale of 1 to 5.

international_reputation

Player's reputation on an international scale, from 1=local to 3=global star.

body_type

Body type of the player ( Lean, Normal, Stocky.

preferred_foot

Dominant foot of the player, either Left or Right.

age

Age of the player in years.

height_cm

Height of the player in centimeters.

weight_kg

Weight of the player in kilograms.

overall

Overall skill rating of the player out of 100.

potential

Potential skill rating the player may achieve in the future.

value_eur

Estimated market value of the player in Euros.

wage_eur

Player's weekly wage in Euros.

release_clause_eur

Release clause value in Euros, which other clubs must pay to buy out the player's contract.

pace

Speed rating of the player out of 100.

shooting

Shooting skill rating out of 100.

passing

Passing skill rating out of 100.

dribbling

Dribbling skill rating out of 100.

defending

Defending skill rating out of 100.

physic

Physicality rating out of 100.

Details

This dataset provides a snapshot of player attributes and performance indicators as represented in FIFA 21 for players in the Dutch League. It can be used to analyze player characteristics, compare skills across players, and explore potential relationships among variables such as age, position, and various skill ratings.

References

Stefano Leone. (2021). FIFA 21 Complete Player Dataset. Retrieved from https://www.kaggle.com/datasets/stefanoleone992/fifa-21-complete-player-dataset.

Examples

data(fifa_nl)
summary(fifa_nl)

Description

Generates synthetic mixed datasets with controllable numerical and categorical signal/noise structure and balanced cluster sizes.

Usage

gen_mixed(
  k_true,
  clustSizeEq = 50,
  numsignal = 2,
  numnoise = 2,
  catsignal = 2,
  catnoise = 2,
  q = 5,
  q_err = 9,
  numsep = 0.1,
  catsep = 0.5,
  seed = NULL,
  error_type = c("normal", "chisq"),
  error_df = 2,
  error_scale = 1
)

Arguments

Value

A list with elements df, X_num, X_cat, y, num_cols, cat_cols

Description

generate toy mixed datasets for the supplementary material: figures 1 to 3

Usage

generate_dataset(
  n,
  porig,
  pn,
  pnnoise,
  pcnoise,
  sigma,
  qoptions,
  seed = NULL,
  mode = "per_variable"
)

Arguments

Description

Predict outcomes from precomputed test-to-training distances, or compute those distances from tabular training and test predictors before predicting.

Usage

knn_dist(
  x,
  y = NULL,
  new_data = NULL,
  k = 5,
  dist_fun = NULL,
  dist_args = list(),
  type = c("class", "prob", "numeric"),
  response = NULL
)

Arguments

Details

Each distance row corresponds to a test observation and each column to a training observation. Distances must be finite and nonnegative. Classification uses an unweighted majority vote; regression uses the mean of the neighbours' outcomes. Distance ties are resolved in training order and class-vote ties in factor-level order. Class probabilities are neighbour class proportions.

No training-to-training matrix is required. With dist_fun = mdist, distance construction uses x as training data and new_data as test data. The function computes distances on each call; it does not return a fitted model. Other distance functions are responsible for their own preprocessing rules. For fitted tidymodels workflows, use nearest_neighbor_dist() with step_mdist() instead.

Value

A factor for type = "class", a data frame with one column per outcome level for type = "prob", or a numeric vector for type = "numeric". Each result has one row or element per test observation.

See Also

mdist(), nearest_neighbor_dist(), step_mdist()

Examples

train <- data.frame(value = c(0, 2, 8, 10))
test <- data.frame(value = c(1, 9))
labels <- factor(c("low", "low", "high", "high"))
d <- mdist(train, new_data = test, preset = "gower")
knn_dist(d, labels, k = 1)
knn_dist(train, labels, new_data = test, k = 1,
         dist_fun = mdist, dist_args = list(preset = "gower"))
train$label <- labels
knn_dist(train, response = "label", new_data = test, k = 1,
         dist_fun = mdist, dist_args = list(preset = "gower"))
knn_dist(d, labels, k = 2, type = "prob")
knn_dist(d, c(0, 2, 8, 10), k = 2, type = "numeric")

Description

Computes leave-one-variable-out (LOVO) diagnostics for a distance specification. The function first computes the full dissimilarity matrix using [mdist()]. It then removes one predictor at a time, recomputes the dissimilarity matrix, and compares each leave-one-variable-out matrix with the full one.

Usage

lovo_mdist(
  x,
  response = NULL,
  ...,
  mds = FALSE,
  dims = 2,
  keep_dist = FALSE,
  cluster_k = NULL,
  cluster_methods = c("pam", "hclust", "spectral"),
  hclust_method = "average",
  spectral_sigma = NULL,
  spectral_nstart = 50,
  response_used = TRUE
)

Arguments

Details

'lovo_mdist()' is useful for assessing how strongly each predictor contributes to a distance-based representation. A predictor is considered influential when removing it produces a large change in the dissimilarity matrix or an optional downstream representation, such as a multidimensional scaling configuration or clustering partition.

In 'autoplot()', 'reorder = TRUE' ranks variables by the selected metric within each variable type, with categorical variables before numerical variables. This preserves the blue/red background bands. 'top_n' selection remains global; without type information, ordering is global.

The returned object contains several LOVO diagnostics. The main distance contribution is measured by the mean absolute difference between the full dissimilarity matrix and each leave-one-variable-out matrix ('mad_importance'). The normalized version is stored as 'relative_distance'.

If 'mds = TRUE', the function also compares classical multidimensional scaling configurations computed from the full and leave-one-variable-out dissimilarities. These diagnostics are stored as 'mds_congruence' / 'cc_importance' and 'ac_importance', the latter corresponding to an alienation coefficient. They are omitted when 'mds = FALSE'.

If 'cluster_k' is supplied, the function additionally computes clustering partitions from the full and leave-one-variable-out dissimilarities and compares them using the adjusted Rand index. The corresponding importance measures are defined as '1 - ARI' and are stored as 'pam_importance', 'hclust_importance', or 'spectral_importance', depending on the selected clustering methods.

Clustering-based diagnostics require the suggested package 'mclust'.

Value

An object of class '"MDistLOVO"'. The main results are stored in the '$results' field as a tibble with one row per left-out variable. The object also has print, summary, and autoplot methods.

See Also

[mdist()], [compare_lovo_mdist()], [spectral_dist()]

Examples

if (requireNamespace("palmerpenguins", quietly = TRUE)) {
  data("penguins", package = "palmerpenguins")

  penguins_small <- palmerpenguins::penguins |>
    dplyr::select(
      species, bill_length_mm, bill_depth_mm, flipper_length_mm,
      body_mass_g, island, sex
    ) |>
    tidyr::drop_na()

  # Distance-based LOVO diagnostics for a Gower distance
  res <- lovo_mdist(
    penguins_small,
    preset = "gower",
    response = species,
    response_used = FALSE
  )

  res
  summary(res)

  # Plot the relative distance contribution of each predictor
  p <- res$autoplot(metric = "relative_distance")
  p
}

Description

Helper to build one method specification for [compare_lovo_mdist()]. This allows tidy-style specification of 'response', e.g. 'response = Name', while storing the method definition as a regular list.

Usage

lovo_method_spec(response = NULL, ...)

Arguments

Value

A named list of arguments suitable for one element of the 'methods' argument in [compare_lovo_mdist()].

Examples

## Not run: 
methods <- list(
  tvd_sup = lovo_method_spec(
    response = species,
    preset = "custom",
    method_cat = "tvd",
    method_num = "std",
    commensurable = TRUE,
    response_used = TRUE
  ),
  tvd_unsup = lovo_method_spec(
    response = species,
    preset = "custom",
    method_cat = "tvd",
    method_num = "std",
    commensurable = TRUE,
    response_used = FALSE
  )
)

## End(Not run)

Description

This helper creates a tidymodels recipe using step_mdist(). It supports both mdist presets and custom param sets.

Usage

make_mdist_recipe(df, mdist_type, mdist_preset, param_set, outcome)

Arguments

Value

A 'recipes::recipe()' object.

Description

Computes a dissimilarity object for numerical, categorical, or mixed-type data. The function combines continuous and categorical components according to either a predefined 'preset' or a user-defined custom specification.

Usage

mdist(
  x,
  new_data = NULL,
  response = NULL,
  method_cat = "tvd",
  method_num = "std",
  commensurable = TRUE,
  ncomp = NULL,
  threshold = NULL,
  preset = "custom",
  interaction = FALSE,
  prop_nn = 0.1,
  score = "ba",
  decision = "prior_corrected",
  gower_average = TRUE
)

Arguments

Details

'mdist()' is the main distance-construction function in 'manydist'. It can return ordinary train-train dissimilarities or rectangular test-to-training dissimilarities when 'new_data' is supplied. The resulting object stores both the dissimilarity matrix and metadata about the distance specification that was used.

With 'preset = "custom"', users manually choose the numerical preprocessing, categorical dissimilarity, commensurability, and optional interaction term.

The '"gower"' preset follows the usual Gower construction based on range scaling for continuous variables and matching dissimilarities for categorical variables. The 'gower_average' argument controls whether the result is averaged over variables or returned as a sum of variable-wise contributions.

The '"u_dep"', '"unbiased_dependent"', '"u_indep"', and '"u_mix"' presets are convenience specifications for unbiased or commensurable mixed-variable dissimilarities. The '"u_dep_bw"' preset uses the same categorical construction as '"u_dep"', but whitens the retained numerical principal components and scales their complete Manhattan distance by the number of original numerical variables divided by its mean over distinct training pairs. The '"euclidean"' preset computes Euclidean distance after standardizing numerical variables and one-hot encoding and standardizing categorical variables. For numerical-only inputs, '"std"' remains the default, but 'method_num' can be overridden. Setting 'method_num = "none"' produces the same numerical distances as [stats::dist()] applied directly to the original variables. The '"gudmm"', '"dkss"', and '"mod_gower"' presets provide additional mixed-type distance constructions. Some presets currently support only train-train distances and will stop if 'new_data' is supplied.

Use [all_dist_method_specs()] to inspect the available distance components and method specifications.

Value

An object of class '"MDist"'. The object contains the computed dissimilarity in its '$distance' field, the selected 'preset', the training data, and a list of parameters describing the fitted distance specification. Square train-train dissimilarities are stored as '"dissimilarity"'/'"dist"' objects; rectangular test-to-training dissimilarities are stored as '"dissimilarity"'/'"matrix"' objects.

See Also

[step_mdist()], [all_dist_method_specs()]

Examples

if (requireNamespace("palmerpenguins", quietly = TRUE)) {
  data("penguins", package = "palmerpenguins")

  penguins_small <- palmerpenguins::penguins |>
    dplyr::select(
      bill_length_mm, bill_depth_mm, flipper_length_mm,
      body_mass_g, species, island, sex
    ) |>
    tidyr::drop_na()

  # Gower distance on mixed-type data
  d_gower <- mdist(penguins_small, preset = "gower")
  d_gower

  # Custom mixed-type specification
  d_custom <- mdist(
    penguins_small,
    preset = "custom",
    method_cat = "matching",
    method_num = "std",
    commensurable = TRUE
  )

  d_custom

  # Train-to-new-data distances
  penguin_split <- rsample::initial_split(penguins_small, prop = 0.75)
  penguin_train <- rsample::training(penguin_split)
  penguin_test  <- rsample::testing(penguin_split)

  d_new <- mdist(
    penguin_train,
    new_data = penguin_test,
    preset = "gower"
  )

  d_new
}

Description

Internal: summary method implementation for MDist R6 objects

Usage

mdist_summary_impl(object, ...)

Arguments

Value

Invisibly returns 'object'.

Description

PAM clustering specification based on manydist dissimilarities

Usage

pam_dist(num_clusters = NULL)

Arguments

Value

A 'pam_dist_spec' object.

Description

Returns the methods in [dist_methods_tbl()] that can use a response variable. The output can optionally be restricted by data type or by 'mdist()' argument.

Usage

response_aware_methods(data_type = NULL, argument = NULL)

Arguments

Value

A character vector of response-aware method names.

Examples

response_aware_methods()
response_aware_methods(argument = "method_cat")
response_aware_methods(argument = "preset")

Description

Spectral clustering specification based on manydist dissimilarities

Usage

spectral_dist(num_clusters = NULL, sigma = NULL, nstart = 50)

Arguments

Value

A 'spectral_dist_spec' object.

Examples

## Not run: 
library(manydist)
library(palmerpenguins)
library(recipes)
library(generics)

data <- penguins |>
  dplyr::select(-species) |>
  tidyr::drop_na()

rec <- recipes::recipe(~ ., data = data) |>
  step_mdist(all_predictors(), preset = "gower", output = "pairwise")

spec <- spectral_dist(num_clusters = 3)

fit_obj <- generics::fit(spec, recipe = rec, data = data)

print(fit_obj)
predict(fit_obj)
predict(fit_obj, type = "embed")

## End(Not run)

Description

Spectral clustering from a distance matrix

Usage

spectral_from_dist(D, k, affinity_method = "selftune")

Arguments

Value

A vector of cluster labels

Description

'step_mdist()' is a [recipes::recipe()] step that replaces selected predictors by a distance-based representation computed with [mdist()]. It is designed for distance-based learning workflows, especially nearest-neighbour prediction and clustering models that operate on dissimilarity matrices.

Usage

step_mdist(
  recipe,
  ...,
  role = "predictor",
  trained = FALSE,
  output = "distance_to_training",
  response_used = TRUE,
  preset = "custom",
  method_cat = "tot_var_dist",
  method_num = NULL,
  commensurable = FALSE,
  ncomp = NULL,
  threshold = NULL,
  columns = NULL,
  response_col = NULL,
  train_predictors = NULL,
  preprocessor = NULL,
  skip = FALSE,
  id = recipes::rand_id("mdist")
)

Arguments

Details

The step can produce either distances from new observations to the training observations, or the within-training pairwise dissimilarity matrix. The former is the usual choice for supervised prediction workflows; the latter is useful for distance-based clustering workflows fitted on the training data.

During [recipes::prep()], 'step_mdist()' stores the selected training predictors and fits the internal manydist preprocessor. During [recipes::bake()], the selected predictors are removed and replaced by distance columns named 'dist_1', 'dist_2', and so on.

When 'response_used = TRUE', the step discovers the outcome from the recipe variable roles. For response-aware presets and custom categorical methods, the outcome from the current analysis set is supplied to [mdist()] during preparation. The fitted response-aware profiles are then reused when new data are baked; assessment and test outcomes are never required or used.

With 'output = "distance_to_training"', baking the training data returns the training pairwise distances, while baking new data returns distances from each new observation to each training observation. This rectangular representation is suitable for nearest-neighbour prediction models.

With 'output = "pairwise"', the step returns the within-training pairwise dissimilarity matrix. Baking genuinely new data is not supported in this mode, because the output is intended for training-only clustering workflows such as [pam_dist()] or [spectral_dist()].

Value

An updated recipe with a manydist step.

See Also

[mdist()], [nearest_neighbor_dist()], [pam_dist()], [spectral_dist()], [all_dist_method_specs()]

Examples

if (requireNamespace("palmerpenguins", quietly = TRUE)) {
  data("penguins", package = "palmerpenguins")

  penguins_small <- palmerpenguins::penguins |>
    dplyr::select(
      species, bill_length_mm, bill_depth_mm, flipper_length_mm,
      body_mass_g, island, sex
    ) |>
    tidyr::drop_na()

  # Distance-to-training representation for prediction workflows
  rec <- recipes::recipe(species ~ ., data = penguins_small) |>
    step_mdist(
      recipes::all_predictors(),
      preset = "gower",
      output = "distance_to_training"
    )

  rec_prep <- recipes::prep(rec, training = penguins_small)
  baked <- recipes::bake(rec_prep, new_data = penguins_small)

  baked |> dplyr::slice_head(n=5)

  # Pairwise representation for clustering workflows
  rec_pairwise <- recipes::recipe(~ ., data = penguins_small) |>
    step_mdist(
      recipes::all_predictors(),
      preset = "gower",
      output = "pairwise"
    )

  rec_pairwise_prep <- recipes::prep(rec_pairwise, training = penguins_small)
  pairwise_dist <- recipes::bake(rec_pairwise_prep, new_data = penguins_small)

  pairwise_dist
}

Description

Displays the pairwise diagnostics already computed by benchmark_mdist(), without refitting distances or recomputing diagnostics.

Usage

## S3 method for class 'MDistBenchmark'
summary(object, ..., n = 10L, width = NULL)

Arguments

Value

Invisibly returns the complete tibble with one row per unique pair of successful specifications, regardless of the display limit n. Columns include the method labels, MAD, symmetric relative distance, MDS congruence, alienation, and any requested clustering ARIs. If fewer than two specifications succeed, the tibble has zero rows.

Examples

## Not run: 
pairwise_results <- summary(benchmark_result)

## End(Not run)

Description

A fixed snapshot of selected economic, demographic, and labour-market indicators for 181 countries, together with World Bank regional, income, and lending classifications. It provides a compact mixed-type dataset for illustrating distance construction and distance-based learning.

Format

A data frame with 181 rows and 9 variables:

country

Country or economy name.

region

World Bank region, as a factor with 7 levels.

income

World Bank income group, as a factor with 5 levels.

lending

World Bank lending category, as a factor with 4 levels.

gdp_pc_kusd

GDP per capita in thousands of current US dollars.

life_exp

Life expectancy at birth, in years.

unemployment

Unemployment as a percentage of the total labour force, based on the modelled ILO estimate.

urban_pop

Urban population as a percentage of the total population.

pop_growth

Annual population growth, in percent.

Details

The reference year is 2022 and the snapshot was retrieved from the World Bank Indicators API on 2026-05-05. Aggregate regions and observations with missing values in any selected field were removed. GDP per capita was divided by 1,000 and rounded to one decimal place; life expectancy, unemployment, and urban population were rounded to one decimal place; and population growth was rounded to two decimal places.

The numerical indicators and their World Bank codes are:

• GDP per capita: NY.GDP.PCAP.CD;

• life expectancy: SP.DYN.LE00.IN;

• unemployment: SL.UEM.TOTL.ZS;

• urban population: SP.URB.TOTL.IN.ZS;

• population growth: SP.POP.GROW.

License

The original World Development Indicators data are distributed by the World Bank under the Creative Commons Attribution 4.0 International license, subject to the World Bank Dataset Terms. Attribution: The World Bank: World Development Indicators.

Source

The World Bank, World Development Indicators, https://datacatalog.worldbank.org/search/dataset/0037712/world-development-indicators.

References

World Bank Dataset Terms, https://www.worldbank.org/ext/en/legal/terms-conditions/datasets.

Examples

data("wdi_2022", package = "manydist")
dplyr::glimpse(wdi_2022)