A placeholder function for argument values that are to be tuned.

Source: R/tune.R

tune() is used when a parameter will be specified at a later date.

tune(id = "")

Arguments

id

A single character value that can be used to differentiate parameters that are used in multiple places but have the same name, or if the user wants a note associated with the parameter.

Value

A call object that echos the user input.

See also

tune_grid(), tune_bayes()

Examples

tune()

#> tune()
class(tune())

#> [1] "call"
tune("your name here")

#> tune("your name here")

# How `tune()` is used in practice:

library(parsnip)
nearest_neighbor(
  neighbors = tune("K"),
  weight_func = tune(),
  dist_power = tune()
)

#> K-Nearest Neighbor Model Specification (unknown)
#> 
#> Main Arguments:
#>   neighbors = tune("K")
#>   weight_func = tune()
#>   dist_power = tune()
#> 
#> Computational engine: kknn 
#>