knit_engine_docs: Knit engine-specific documentation

View source: R/engine_docs.R

knit_engine_docsR Documentation

Knit engine-specific documentation

Description

Knit engine-specific documentation

Usage

knit_engine_docs(pattern = NULL)

Arguments

pattern

A regular expression to specify which files to knit. The default knits all engine documentation files.

Details

This function will check whether the known parsnip extension packages, engine specific packages, and a few other ancillary packages are installed. Users will be prompted to install anything required to create the engine documentation.

Value

A tibble with column file for the file name and result (a character vector that echos the output file name or, when there is a failure, the error message).


tidymodels/parsnip documentation built on Feb. 19, 2025, 2:10 a.m.