为包编写 R 演示
Writing R demos for a package
我真的有一个非常简单的问题。有一个演示函数 demo() 即 demo(scoping) 运行该主题的演示。我如何为我自己的包裹写这样的东西？这太疯狂了，但我已经尝试用谷歌搜索与它相关的任何文档，但有 none 可用（要么是那个，要么是我的谷歌搜索技能很糟糕）。我也尝试了 devtools 和 roxygen 的文档，但也许我错过了。
任何人都可以指出我正确的方向吗？是否有任何包可以在包安装期间生成它？还是我必须手动编写它（我对此完全没问题，但现在我对此的信息为零）。
是的，我希望能够在 R 控制台（而不是 rstudio）中完成。
虽然 roxygen2 不允许您创建演示，但它允许您在文档 [1] 中包含特殊的 @examples。这些显示在您的函数或对象帮助页面中，甚至可以在加载包时自动 运行 以测试功能依赖性，或者它们可以作为最终用户的示例。
另一方面，devtools 提供 vignettes，这是 "long-form guide to your package"[2]。这些可以通过您的整个包文档访问，并且实际上链接到您文档中的任何地方。您可以制作多个小插曲并使它们发挥作用或 work-flow 特定，按功能系列或类似的东西组织。
如果您坚持使用演示，您将不得不手动完成建立正确目录、格式化和测试演示文件的麻烦。如果您确实打算沿着这条路走下去，Hadley Wickham 在此处提供了一些关于该主题的非常 的稀疏文档：[3].
我真的有一个非常简单的问题。有一个演示函数 demo() 即 demo(scoping) 运行该主题的演示。我如何为我自己的包裹写这样的东西？这太疯狂了，但我已经尝试用谷歌搜索与它相关的任何文档，但有 none 可用（要么是那个，要么是我的谷歌搜索技能很糟糕）。我也尝试了 devtools 和 roxygen 的文档，但也许我错过了。
任何人都可以指出我正确的方向吗？是否有任何包可以在包安装期间生成它？还是我必须手动编写它（我对此完全没问题，但现在我对此的信息为零）。
是的，我希望能够在 R 控制台（而不是 rstudio）中完成。
虽然 roxygen2 不允许您创建演示，但它允许您在文档 [1] 中包含特殊的 @examples。这些显示在您的函数或对象帮助页面中，甚至可以在加载包时自动 运行 以测试功能依赖性，或者它们可以作为最终用户的示例。
devtools 提供 vignettes，这是 "long-form guide to your package"[2]。这些可以通过您的整个包文档访问，并且实际上链接到您文档中的任何地方。您可以制作多个小插曲并使它们发挥作用或 work-flow 特定，按功能系列或类似的东西组织。
如果您坚持使用演示，您将不得不手动完成建立正确目录、格式化和测试演示文件的麻烦。如果您确实打算沿着这条路走下去，Hadley Wickham 在此处提供了一些关于该主题的非常 的稀疏文档：[3].