Skip to contents

Create a fake package

Source: R/create_pkg_stub.R
create_pkg_stub.Rd

Create a minimal package for testing purposes.

Usage

create_pkg_stub(
  name,
  path,
  action_on_failure = c("error", "warning", "message"),
  show_progress = FALSE
)

Arguments

name

Character string with the name of the package.

path

Character string with the path to the directory where the package should be installed. See Details.

action_on_failure

Character string indicating the action if package installation fails: "error" (default) to throw an error, "warning" to issue a warning, or "message" to show a message. See Details.

show_progress

TRUE or FALSE: show progress of the installation?

Value

A character string with the normalised path to the package directory, returned invisibly. Identical to file.path(path, name) if path is already normalized and points to a writeable directory.

Details

path should not include the package name.

If the package is already installed at the directory given by path, the action taken by action_on_failure will be triggered.

The check if the package is functioning correctly after installation first looks for the package in the directory given by path. If it is not found there, it will look for the package in the user directory (with a warning) because utils::install.packages() will ask if that directory should be used if path does not point to a writeable directory. If the packag is not functioning correctly, the action taken by action_on_failure will be triggered.