Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add extract_postprocessor() to docs for extract_*() functions #249

Open
hfrick opened this issue May 1, 2024 · 0 comments
Open

Add extract_postprocessor() to docs for extract_*() functions #249

hfrick opened this issue May 1, 2024 · 0 comments

Comments

@hfrick
Copy link
Member

hfrick commented May 1, 2024

It should also be listed in the @description

hardhat/R/extract.R

Lines 3 to 17 in ae8fba7

#' @description
#' These generics are used to extract elements from various model
#' objects. Methods are defined in other packages, such as tune,
#' workflows, and workflowsets, but the returned object is always the same.
#'
#' - `extract_fit_engine()` returns the engine specific fit embedded within
#' a parsnip model fit. For example, when using `parsnip::linear_reg()`
#' with the `"lm"` engine, this returns the underlying `lm` object.
#'
#' - `extract_fit_parsnip()` returns a parsnip model fit.
#'
#' - `extract_mold()` returns the preprocessed "mold" object returned
#' from [mold()]. It contains information about the preprocessing,
#' including either the prepped recipe, the formula terms object, or
#' variable selectors.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant