R语言【cli】——通过cli_abort用 cli 格式的内容显示错误、警告或信息,内部调用cli_bullets和inline-makeup

本文主要是介绍R语言【cli】——通过cli_abort用 cli 格式的内容显示错误、警告或信息,内部调用cli_bullets和inline-makeup,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

cli_abort(message,...,call = .envir,.envir = parent.frame(),.frame = .envir
)

我先从那些不需要下大力气理解的参数入手:

        参数【.envir】:进行万能表达式编译的环境。

        参数【.frame】:抛出上下文。默认用于 .trace_bottom,当 .internal 为 TRUE 时,用于确定在内部错误中提及的内部软件包。

        参数【call】:当前运行函数的执行环境,例如 call = caller_env()。相应的函数调用会被检索出来,并在错误信息中作为错误源被提及。您只需要在从辅助函数抛出条件时提供调用即可,而无需在信息中提及。

        参数【...】:传递给rlang::abort(),rlang::warn()或rlang::warn()的参数。


以上都是不太需要进行修改的参数,所以本文的重点将放在参数【message】上。只需将希望输出的文本信息传递给参数【message】即可:

cli_abort(c("this is my error! Do not mess with R!"))

输出了警告信息:

Error:
! this is my error! Do not mess with R!
Run `rlang::last_trace()` to see where the error occurred.

        参数【message】:它是通过调用 cli_bullets()进行格式化的。进一步地,还需要调用 inline-makeup(内联标记)。


Package cli version 3.6.2

在cli_bullets()中内置定义了许多标记主题类型,只需要使用定义的主题名称:

cli_bullets()的内置标记
cli_bullets(c("noindent"))
noindent
没有任何前缀
cli_bullets(c(" " = "indent"))
  indent
缩进前缀
cli_bullets(c("*" = "bullet"))
• bullet
圆点前缀
cli_bullets(c(">" = "arrow"))
→ arrow
箭头前缀
cli_bullets(c("v" = "success"))
✔ success
对号前缀
cli_bullets(c("x" = "danger"))
✖ danger
错号前缀
cli_bullets(c("!" = "warning"))
! warning
惊叹号前缀
cli_bullets(c("i" = "info"))
ℹ info
信息前缀
cli_bullets() 和 cli_abort()的标记对比
cli_bullets(c("noindent"," " = "indent","*" = "bullet",">" = "arrow","v" = "success","x" = "danger","!" = "warning","i" = "info"
))
cli_abort(c("noindent"," " = "indent","*" = "bullet",">" = "arrow","v" = "success","x" = "danger","!" = "warning","i" = "info"
))

inline-markup可以让输出的信息更加多元,更加清晰。由R包cli输出的文本都支持万能语法插值,详见glue::glue()。cli支持通过使用类型名称对部分文本内容添加格式。例如:

cli_text("This is {.emph important}.")

上述代码给文本 "important" 添加了一个格式 "emph"。注意本例中大括号内的字符串通常不会是一个可运行的R表达式。如果打算运用插值,可以再使用一个大括号{}:

adjective <- "great"
cli_text("This is {.emph {adjective}}.")

每个inline类总会在内部创建一个span元素。所以使用主题时,可以通过span.emph的CSS选择器来改变文本的强调显示格式:

cli_div(theme = list(span.emph = list(color = "red")))
adjective <- "nice and red"
cli_text("This is {.emph {adjective}}.")

cli默认提供的主题

arg用于函数的参数
cls用于S3,S4,R6或其余类的名称
code用于一段代码
dt用于一个命名列表的元素,表格形式
dd用于一个命名列表的描述,表格形式
email用于email地址。如果输出终端支持ANSI超链接(比如RStudio,iTerm2等),那么cli就会生成一个可点击的链接。
emph用于突出显示文本
envvar用于环境变量的名称
field用于通用字段,比如一个命名列表
file用于文件名称。如果输出终端支持ANSI超链接(比如RStudio,iTerm2等),那么cli就会生成一个可点击的链接,点击后就会在RStudio打开该文件或在该文件类型的默认软件中打开。
fn用于函数名称。如果输入的是package::function_name形式,并且输出终端支持ANSI超链接(比如RStudio,iTerm2等),那么cli就会生成一个可点击的链接。
fun与fn相同
help用于函数的帮助页面。如果输出终端支持ANSI超链接至帮助页面(比如RStudio),那么cli就会生成一个可点击的链接。
href用于创建一个超链接,可能带有链接文本。如果输出终端支持ANSI超链接(比如RStudio,iTerm2等),那么cli就会生成一个可点击的链接。
kbd用于键盘键
key与kbd相同
obj_type_friendly用于以可读方式格式化 R 对象的类型,应与 {} 一起使用。
or将分隔折叠矢量最后两个元素的字符串从 "和 "改为 "或"。
path用于文件路径,与file相同。
pkg用于包的名称。
run用于R表达式,如果输出终端支持ANSI超链接至可运行的代码,那么该链接可能可以点击。
str双引号引用字符串
topic用于标题的帮助页面。
type用于以可读方式格式化 R 对象的类型,应与 {} 一起使用。
url用于网址。如果输出终端支持ANSI超链接(比如RStudio,iTerm2等),那么cli就会生成一个可点击的链接。
var用于变量名称。
val用于通用值。
vignette

用于插件。如果输出终端支持ANSI超链接(比如RStudio,iTerm2等),那么cli就会生成一个可点击的链接。

这篇关于R语言【cli】——通过cli_abort用 cli 格式的内容显示错误、警告或信息,内部调用cli_bullets和inline-makeup的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/519923

相关文章

Python将博客内容html导出为Markdown格式

《Python将博客内容html导出为Markdown格式》Python将博客内容html导出为Markdown格式,通过博客url地址抓取文章,分析并提取出文章标题和内容,将内容构建成html,再转... 目录一、为什么要搞?二、准备如何搞?三、说搞咱就搞!抓取文章提取内容构建html转存markdown

Go标准库常见错误分析和解决办法

《Go标准库常见错误分析和解决办法》Go语言的标准库为开发者提供了丰富且高效的工具,涵盖了从网络编程到文件操作等各个方面,然而,标准库虽好,使用不当却可能适得其反,正所谓工欲善其事,必先利其器,本文将... 目录1. 使用了错误的time.Duration2. time.After导致的内存泄漏3. jsO

在C#中调用Python代码的两种实现方式

《在C#中调用Python代码的两种实现方式》:本文主要介绍在C#中调用Python代码的两种实现方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录C#调用python代码的方式1. 使用 Python.NET2. 使用外部进程调用 Python 脚本总结C#调

使用Python实现获取网页指定内容

《使用Python实现获取网页指定内容》在当今互联网时代,网页数据抓取是一项非常重要的技能,本文将带你从零开始学习如何使用Python获取网页中的指定内容,希望对大家有所帮助... 目录引言1. 网页抓取的基本概念2. python中的网页抓取库3. 安装必要的库4. 发送HTTP请求并获取网页内容5. 解

如何自定义Nginx JSON日志格式配置

《如何自定义NginxJSON日志格式配置》Nginx作为最流行的Web服务器之一,其灵活的日志配置能力允许我们根据需求定制日志格式,本文将详细介绍如何配置Nginx以JSON格式记录访问日志,这种... 目录前言为什么选择jsON格式日志?配置步骤详解1. 安装Nginx服务2. 自定义JSON日志格式各

Python中ModuleNotFoundError: No module named ‘timm’的错误解决

《Python中ModuleNotFoundError:Nomodulenamed‘timm’的错误解决》本文主要介绍了Python中ModuleNotFoundError:Nomodulen... 目录一、引言二、错误原因分析三、解决办法1.安装timm模块2. 检查python环境3. 解决安装路径问题

如何解决mysql出现Incorrect string value for column ‘表项‘ at row 1错误问题

《如何解决mysql出现Incorrectstringvalueforcolumn‘表项‘atrow1错误问题》:本文主要介绍如何解决mysql出现Incorrectstringv... 目录mysql出现Incorrect string value for column ‘表项‘ at row 1错误报错

python dict转换成json格式的实现

《pythondict转换成json格式的实现》本文主要介绍了pythondict转换成json格式的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下... 一开始你变成字典格式data = [ { 'a' : 1, 'b' : 2, 'c编程' : 3,

C语言中的数据类型强制转换

《C语言中的数据类型强制转换》:本文主要介绍C语言中的数据类型强制转换方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录C语言数据类型强制转换自动转换强制转换类型总结C语言数据类型强制转换强制类型转换:是通过类型转换运算来实现的,主要的数据类型转换分为自动转换

利用Go语言开发文件操作工具轻松处理所有文件

《利用Go语言开发文件操作工具轻松处理所有文件》在后端开发中,文件操作是一个非常常见但又容易出错的场景,本文小编要向大家介绍一个强大的Go语言文件操作工具库,它能帮你轻松处理各种文件操作场景... 目录为什么需要这个工具?核心功能详解1. 文件/目录存javascript在性检查2. 批量创建目录3. 文件