dials: pull_dials_object – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

pull_dials_object

Return a dials parameter object associated with parameters

Description

pull_dials_object() can extract a single dials parameter object from different types of objects (e.g. parameter sets, recipes, etc.).

Usage

pull_dials_object(x, id, ...)

## S3 method for class 'parameters'
pull_dials_object(x, id, ...)

## S3 method for class 'recipe'
pull_dials_object(x, id, ...)

## S3 method for class 'model_spec'
pull_dials_object(x, id, ...)

## S3 method for class 'workflow'
pull_dials_object(x, id, ...)

Arguments

`x`	The results of a call to `parameters()`, a recipe, model specification, or workflow.
`id`	A single string for the `id` of the parameter.
`...`	Not currently used.

Value

A dials parameter object.

Examples

glmn_param <- parameters(lambda = penalty(), mixture())
pull_dials_object(glmn_param, "lambda")

# fails:
# pull_dials_object(glmn_param, "penalty")

dials

Tools for Creating Tuning Parameter Values

v0.0.10

MIT + file LICENSE

Authors

Max Kuhn [aut], Hannah Frick [aut, cre], RStudio [cph]

Initial release