Skip to contents

Construct a stat_command entry

Usage

stat_command(
  name,
  category,
  usage,
  description,
  handler_repl,
  handler_stat = NULL,
  aliases = character(0),
  module = "",
  is_compound = FALSE,
  is_r_bridge = FALSE
)

Arguments

name

Canonical command name (character scalar).

category

Category label used for grouping.

usage

One-line usage string for help screens.

description

Short description.

handler_repl

Function implementing the command.

handler_stat

Optional terminal handler taking (parts, log, store). Defaults to a wrapper around handler_repl.

aliases

Character vector of additional names.

module

Source module string (informational).

is_compound

Logical; flags compound workflows.

is_r_bridge

Logical; flags Python <-> R bridge calls.

Value

A list with class morie_stat_command.