potions: potions: simple options management

potionsR Documentation

potions: simple options management

Description

Often it is useful to set bespoke options for a single workflow, or within a single package, without altering global options that influence other users or packages. This is possible base::options() and related functions, however doing so requires some bespoke knowledge. potions makes options management as easy as possible, by decreasing programmers' cognitive burden while storing and retrieving information. It does this by following three guiding principles:

  • minimalist: potions has only three core functions

  • laconic: functions use as few characters as possible

  • familiar: uses a UI for data retrieval based on the {here} package

In combination, these features should make it easy for users and developers to manage options using potions.

Functions

  • brew(): store data in options()

  • pour(): retrieve data from options()

  • drain(): remove data stored using brew()

Author(s)

Maintainer: Martin Westgate martin.westgate@csiro.au

See Also

Useful links:


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