copy_default_params: Copy Default Parameters File

View source: R/data_loading.R

copy_default_paramsR Documentation

Copy Default Parameters File

Description

Copies the default params.yaml file, included with the package, to a specified destination directory. This is useful for initializing parameter files for custom edits.

Usage

copy_default_params(dest_dir)

Arguments

dest_dir

Character. The path to the directory where the params.yaml file will be copied.

Details

The params.yaml file contains default model parameters for various configurations such as LightGBM, dynamic regression, and others. See the load_params()‘ documentation for an example of the file’s structure.

Value

Nothing is returned. A message is displayed upon successful copying.

Examples

copy_default_params(tempdir())

ubair documentation built on April 12, 2025, 2:12 a.m.