Disable a Category for a Volume — disable_volume_category • databraryr

Remove a single category from a volume's enabled set. Other enabled categories are preserved. No-op if the category is not currently enabled.

Usage

disable_volume_category(
  vol_id = 1,
  category_id,
  vb = options::opt("vb"),
  rq = NULL
)

Arguments

vol_id: Target volume number. Must be a positive integer.
category_id: Numeric category identifier to disable.
vb: Show verbose messages. (Defaults to FALSE, overwritable using option 'databraryr.vb' or environment variable 'R_DATABRARYR_VB')
rq: An httr2 request object. Defaults to NULL.

Value

TRUE on success (or if not currently enabled), NULL on failure.

Examples

# \donttest{
if (FALSE) { # \dontrun{
disable_volume_category(vol_id = 1, category_id = 1)
} # }
# }