attach_pkgs: Fully attach or load packages for making model predictions

Description Usage Arguments Details Value Examples

View source: R/attach-pkgs.R

Description

These are developer-facing functions, useful for supporting new model types. Some models require one or more R packages to be fully attached to make predictions, and some require only that the namespace of one or more R packages is loaded.

Usage

1
2
3
attach_pkgs(pkgs)

load_pkgs(pkgs)

Arguments

pkgs

A character vector of package names to load or fully attach.

Details

These two functions will attempt either to:

the namespace of the pkgs vector of package names, preserving the current random seed.

To learn more about load vs. attach, read the NAMESPACE chapter of R Packages. For deploying a model, it is likely safer to fully attach needed packages but that comes with the risk of naming conflicts between packages.

Value

An invisible TRUE.

Examples

1
2
3
4
5
6
7
## succeed
load_pkgs(c("knitr", "readr"))
attach_pkgs(c("knitr", "readr"))

## fail
try(load_pkgs(c("bloopy", "readr")))
try(attach_pkgs(c("bloopy", "readr")))

tidymodels/vetiver documentation built on Jan. 14, 2022, 7:32 p.m.