为软件包编写R演示

我有一个非常简单的问题。有一个演示函数

demo（）

，即

demo（作用域）

，它运行主题的演示。我如何为我自己的软件包写这样的东西？这太疯狂了，但我已经尝试过在谷歌上搜索任何与之相关的文档，但是没有可用的文档（要么是这样，要么是我的谷歌技能太差了）。我也尝试了devtools和roxygen的文档，但可能我错过了

有人能给我指出正确的方向吗？在软件包安装过程中是否有可以生成它的软件包？或者我必须手动编写（我完全同意，但现在我没有这方面的信息）

---

是的，我希望能够在R控制台（而不是rstudio）中进行演示。

虽然

roxygen2

不允许您创建演示，但它允许您在文档[]中包含特殊的

@示例。这些将显示在函数或对象帮助页面中，甚至可以在加载包时自动运行以测试功能依赖性，或者它们可以作为最终用户的示例

另一方面，
devtools
提供了小插曲，这是一个“软件包的长格式指南”[]。这些可以通过您的整个软件包文档进行访问，并实际链接到文档中的任何位置。您可以制作多个渐晕图，并使其功能或工作流程特定，按功能系列或类似内容组织

如果您坚持使用演示，那么您必须手动完成建立正确目录、格式化和测试演示文件的过程。如果你真的想走这条路，Hadley Wickham在这里有一些关于这个主题的非常稀疏的文档：[]。
请参阅。基本上只是
demo/
文件夹中的.R脚本。因为@Marius提供的链接也很好地说明了演示并不是那么有用——渐晕图是优越的，因为它们列在CRAN上（因此很容易找到），在包构建时检查其正确性（这样你就知道它们何时中断），并且可以包括输出和叙述性解释（因此用户不必实际运行示例来了解发生了什么）。尽管这个问题几乎是（推荐…一个非现场资源），我认为它是相关的，对后续读者来说仍然非常有用。虽然马吕斯的链接解决了这个问题，但我觉得米切克的评论和亚历克的回答解决了隐含的需求，即促进包中概念的交互演示。（我进一步建议，r-console作为一种严格的必需品是不幸的，尽管良好的“Rmd”渐晕图仍然可以复制并粘贴到控制台上。）没有任何东西需要Rmd文档在RStudio中编写。模板和快捷方式很方便，但是你可以在任何你想要的文本编辑器中编写。更重要的是：一个以Rmarkdown形式编写的小插曲（在我看来）更方便的一点是，我可以在我选择的R浏览器中直接打开和编辑它，并与之交互；严格为pdf格式的渐晕图仍然可以复制，但添加了一层不太方便的间接层。感谢您的输入。我已经访问了链接（3）您提到并认为应该有更多的信息，但从我收集的信息来看，关于这个主题的内容并不多。我知道一些示例和小插曲，它们都是指导用户使用软件包的非常有用的工具。我正在考虑将这三者结合起来，从用户体验角度（idk）来看可能会很有用？我的目标是帮助我的用户在不打开任何新标签的情况下破解我的软件包，如果他们需要更详细的解释，就会有小插曲。好吧，我会试试看。小插曲和示例通常就足够了，但如果你愿意多做一点，没有理由不放一个演示。链接只是Wickha在m的演示摘要中，官方R文献或语言文档中没有太多关于它们的内容，因此最好的方法可能是将您的演示文件夹建立在您欣赏的演示软件包中的一个文件夹的基础上。