build_model_package: Builds a package from your pipeline

Description Usage Arguments Details Value

View source: R/deploy.R

Description

Builds a package from your pipeline

Usage

1
2
3
4
build_model_package(trained_pipeline, package_name = "deploymodel",
  libraries = names(utils::sessionInfo()$otherPkgs),
  tar_file = "deploy.tar.gz", extra_variables = character(0),
  may_overwrite_tar_file = F, verbose = F)

Arguments

trained_pipeline

The model function from find_best_models

package_name

The name of the package

libraries

A list of library names required by the package. Defaults to all loaded non-base packages

tar_file

The name and path of the final tarred package

extra_variables

A character vector of variables names to be included in the package. Used to include extra fuctions and variables in the packages that are not contained in any of the packages listed in libraries.

may_overwrite_tar_file

Flag indicating if, when tar_file exists, this function is allowed to override it.

verbose

Flag indicating if devtools functions should print anything.

Details

A tip for finding out which libraries you need: start with just datapiper, build the package and check the output of building the package. It will display which functions you use that aren't included yet.

Value

A logical: TRUE for success and FALSE for failure


jeroenvdhoven/datapiper documentation built on July 14, 2019, 9:34 p.m.