为包编写R演示

时间:2018-03-23 04:26:48

标签: r devtools r-package roxygen2

我真的有一个非常简单的问题。有一个演示函数demo(),即demo(scoping),它运行该主题的演示。我如何为自己的包写这样的东西?它疯了,但我已经尝试使用谷歌搜索与它相关的任何文档,但没有可用的(要么或我的谷歌搜索技能很大的时间)。我也尝试了devtools和roxygen的文档,但也许我错过了它。

有人能指出我正确的方向吗?是否有任何包可以在包安装过程中生成它?或者我必须手动编写它(我对此完全没问题,但是现在我对此没有任何信息)。

是的,我希望能够在R控制台(不是rstudio)中完成。

1 个答案:

答案 0 :(得分:3)

虽然roxygen2不允许您创建演示,但它允许您在文档[1]中包含特殊@examples。这些显示在您的函数或对象帮助页面中,甚至可以在加载包时自动运行以测试功能依赖性,或者它们可以作为最终用户的示例。

另一方面,

devtools提供了插图短片,这是您的包裹的长期指南" [2]。这些可以通过整体软件包文档访问,并实际链接到文档中的任何位置。您可以制作多个小插图并使其功能或特定于工作流程,按功能族或类似的方式组织。

如果您坚持使用演示,那么您必须手动完成建立正确目录,格式化和测试演示文件的麻烦。如果你打算沿着这条路走下去,Hadley Wickham在这里有关于这个主题的一些非常稀疏的文档:[3]。