drain: Clear package options

In potions: Easy Options Management

Clear package options

Description

Clear options of previously specified content. In most cases, calling drain with no arguments will be sufficient, but the arguments .slot and .pkg, and their corresponding functions drain_interactive() and drain_package() are provided in case greater control is needed. This is rarely needed for packages, but it is possible to manually specify the use of multiple slots when using potions::brew() interactively.

Usage

drain(.slot, .pkg)

drain_package(.pkg)

drain_interactive(.slot)

Arguments

.slot	(optional) slot to clear from options()
.pkg	(optional) package to clear from options()

Details

Note that this function is not vectorized, so passing multiple values to .slot or .pkg will fail (e.g. drain(.slot = c("x", "y"))). Similarly, passing arguments to both .slot and .pkg will fail.

Value

This function never returns an object; it is called for its' side- effect of removing data from options().

potions documentation built on Aug. 23, 2023, 9:07 a.m.