R语言【cli】——通常，您调用cli_process_start()来启动进程，然后在完成后调用cli_process_done()。

ALittleHigh2024-01-19 13:47

Package cli version 3.6.0

Usage

R 复制代码

cli_process_start(
  msg,
  msg_done = paste(msg, "... done"),
  msg_failed = paste(msg, "... failed"),
  on_exit = c("auto", "failed", "done"),
  msg_class = "alert-info",
  done_class = "alert-success",
  failed_class = "alert-danger",
  .auto_close = TRUE,
  .envir = parent.frame()
)

Arguments

参数【msg】：要显示的用于指示进程或计算开始的消息。它将被折叠成一个字符串，第一行将被保留并剪切为 console_width()。

参数【msg_done】：用于成功终止的消息。

参数【msg_failed】：用于不成功终止的消息。

参数【on_exit】 ：当调用函数(或 参数【.envir】 中的环境)退出时，此进程是否应该失败或成功终止。

参数【msg_class】：要添加到消息中的样式类。使用空字符串来抑制样式。

参数【done_class】：要添加到成功终止消息中的样式类。使用空字符串来抑制样式设置

参数【failed_class】：要添加到不成功的终止消息的样式类。使用空字符串来抑制样式设置

参数【.auto_close】：是否在调用函数结束时清除状态栏(或者如果指定的话，从堆栈中移除 参数【.envir】)。

参数【.envir】：评估 glue 表达式的环境。如果 .auto_close 为 TRUE，它也用于自动清除状态栏。

Detail

如果您处理进程或计算的错误，那么您可以做相反的事情：使用on_exit = "done"调用cli_process_start()，并在错误处理程序中调用 cli_process_failed()。当调用函数结束时，cli 将在成功终止时自动调用cli_process_done()。

Value

状态栏容器的Id。