summary object for parameter sets

[topepo]

We might want to make a summary function for a parameters object that does more printing about the parameters, including:

• range values that are different from the defaults
• dials function names that are different from the parameter name (e.g. degree() versus degree_int(), mtry versus mtry_prop())
• where the parameter object exists if not dials

and other things that people trip over.

[hfrick]

For illustration, this is what we get via the print() method for parameter sets

library(parsnip)
library(dials)
#> Loading required package: scales

# `degree` argument uses `prod_degree()` object
params_svm <- svm_poly(degree = tune()) |>
  set_engine("kernlab") |>
  set_mode("regression") |>
  extract_parameter_set_dials()

# BUT print method shows `degree` as the type
# so we can't tell that it's a different dials parameter
params_svm
#> Collection of 1 parameters for tuning
#> 
#>  identifier   type    object
#>      degree degree nparam[+]
#> 

# AND it doesn't show the range 
# so we can't tell that it's different from vanilla dials
params_svm$object[[1]]
#> Degree of Interaction (quantitative)
#> Range: [1, 3]
prod_degree()
#> Degree of Interaction (quantitative)
#> Range: [1, 2]

^{Created on 2025-11-06 with reprex v2.1.1}