r - 如何让评论出现在自定义函数中

Question

使用 RStudio 我注意到，在调用函数时，我可以点击选项卡，然后会出现一个弹出窗口，其中包含可以选择的可能参数，例如如果我输入 round( 并点击 tab，x= 和 digits= 将作为可能的选项出现。这也发生在我编写的自定义函数中. 不同之处在于内置函数弹出窗口还对各个参数进行了注释和解释。是否也可以使用自定义函数重新创建这样的行为？

Answer 1

我明白你的意思了。如果你写一个自定义函数

foo = function(x,y) { ... }

然后你去 foo( 并点击 Tab，代码完成弹出菜单会给你选项 x = 和 y = . 然而，当你键入一个现有的 R 函数时，例如 round(，tab 不仅会为你提供选项，而且每个变量下面都有一个解释，告诉你它在函数中的作用:

我能想到的对您自己的函数执行此操作的唯一方法是将您的函数打包到您自己的自定义包中，并确保“帮助”文档包含您的函数参数。这超出了 stackoverflow 问题的范围，但我会向您指出几个博客，我在这些博客中学习了 R 包的基础知识。

Not So Standard Deviation博客解释了如何使用帮助文档编写一个简单的程序包，这正是您在 RStudio 的自动完成功能中看到您的自定义函数以及解释所需要的。简而言之，您需要安装 roxygen2、devtools，并且对于每个自定义函数，您都需要像这样彻底注释该函数:

(免责声明:傻猫示例是博主的，不是我的)

Here's a more detailed tutorial关于创建 R 包，这里是 another blog on getting organised with R packages .祝你好运!