首页 文章

是否可以让RStudio显示自定义函数的函数参数和描述?

提问于
浏览
8

RStudio中的代码完成很棒,我真的很喜欢弹出窗口如何描述函数输入的参数 . 例如,如果键入 matrix( 然后按"tab",则会显示 matrix() 函数的参数列表以及输入的说明 . 比如,选择了 nrow= ,然后相邻的窗口将 nrow 输入描述为"the desired number of rows." .

我可以让RStudio为我的自定义函数执行此操作吗?我是否必须创建一个包来实现这种效果?

假设我有一个充满自定义函数的文件 myCustomFunctions.R ,并且我将所有杂项辅助函数存储在那里 . 我希望能够为我的函数添加元数据,以便此辅助窗口也描述我的函数输入 .

2 回答

  • 7

    为了在评论中添加Hadley的答案,Rstudio正在挖掘帮助文件的特定部分以生成帮助窗口 . 具体来说,括号前的标签会显示“用法”和“描述”部分以及括号内的标签或逗号之后的标签会显示“参数”部分 . 因此,不仅需要创建包,还必须生成帮助文件以利用此功能 .

  • 0

    跟进Hadley:即使这些功能仅供您自己使用,也值得将它们打包 . 然后,您将获得免费的许多有用的东西,超出包文档系统:版本控制,单元测试,可移植性,可共享......我可以继续 . 在你回到有趣的部分之前,你必须克服一个小的潜在障碍(即黑客攻击自己的东西),但是值得投入时间 .

    Hadley公开热烈地描述了如何获取我认为值得付出的所有好东西(我做过) .

相关问题