R 如何向控制台显示自定义功能摘要/简介?
这可能是一件小事,但我只是希望看看是否有更好的方法来做到这一点 我编写了一个自定义函数,并希望在输入时在控制台上显示摘要或简介文本,而不带任何参数,即name-of-custom-function()。除了向我显示参数列表(一个简单的str()可以做的事情),我还打算在将来提醒自己 为了当前解决这个问题,我将第一个参数设置为默认NULL,并运行“if”语句检查NULL我的问题是:在编写自定义函数时,R是否有一个内置函数/方法将某些用户指定的文本设置为默认介绍,还是我必须自己在函数本身中处理它(例如,使用我的“is.null测试”? 示例代码如下所示:R 如何向控制台显示自定义功能摘要/简介?,r,function,console,summary,R,Function,Console,Summary,这可能是一件小事,但我只是希望看看是否有更好的方法来做到这一点 我编写了一个自定义函数,并希望在输入时在控制台上显示摘要或简介文本,而不带任何参数,即name-of-custom-function()。除了向我显示参数列表(一个简单的str()可以做的事情),我还打算在将来提醒自己 为了当前解决这个问题,我将第一个参数设置为默认NULL,并运行“if”语句检查NULL我的问题是:在编写自定义函数时,R是否有一个内置函数/方法将某些用户指定的文本设置为默认介绍,还是我必须自己在函数本身中处理它(例
myprint <- function(x=NULL, y, ...)
{
if(is.null(x)==TRUE)
{
writeLines( "\nNOTE: This function prints to console what the user keys in.\nmyprint() Function ver 0.1")
}else
{
print(x)
}
} ### End of myprint() function ###
myprint有很多方法可以做到这一点,而“优雅”似乎是一个主观标准。因此,这个问题可能不太适合这样问。然而,为了提供一种选择,您可以使用missing
而不是is.null
范式。@BenBarnes,我同意“优雅”是相当主观的。已将我的问题编辑为:“R是否具有内置函数/方法,可在编写自定义函数时将某些用户指定的文本设置为默认介绍,还是必须在函数本身内自行处理(例如,使用“is.null test”)。希望这足够清楚。如果您正在寻找一个系统来记录功能以供将来参考,@hadley有一个很好的参考,他在其中描述了roxygen系统的功能/包文档。强烈推荐。哈德利的文件看起来像我要找的。我来看看。谢谢你,本巴恩斯!