crew_deprecate {crew}

Deprecate a crew feature.

Description

Show an informative warning when a crew feature is deprecated.

Usage

crew_deprecate(
  name,
  date,
  version,
  alternative,
  condition = "warning",
  value = "x",
  skip_cran = FALSE,
  frequency = "always"
)

Arguments

name

Name of the feature (function or argument) to deprecate.

date

Date of deprecation.

version

Package version when deprecation was instated.

alternative

Message about an alternative.

condition

Either "warning" or "message" to indicate the type of condition thrown on deprecation.

value

Value of the object. Deprecation is skipped if value is NULL.

skip_cran

Logical of length 1, whether to skip the deprecation warning or message on CRAN.

frequency

Character of length 1, passed to the .frequency argument of rlang::warn().

Value

NULL (invisibly). Throws a warning if a feature is deprecated.

See Also

Other utility: crew_assert(), crew_clean(), crew_eval(), crew_random_name(), crew_retry(), crew_terminate_process(), crew_terminate_signal(), crew_worker()

Examples

suppressWarnings(
  crew_deprecate(
    name = "auto_scale",
    date = "2023-05-18",
    version = "0.2.0",
    alternative = "use the scale argument of push(), pop(), and wait()."
  )
)