将带有示例的 R 脚本附加到 R 包的最佳做法是什么?
What is the best practice in attaching R scripts with examples to an R package?
我想知道将带有示例的 R 脚本附加到 R 包的最佳做法是什么。我指的是带有示例的 R 脚本,例如:
- 超出简单函数 运行 示例(例如带有可视化图),有 10-30 行代码,因此对我来说太长了,无法将它们作为 "Example" 在包文档中
- 是从较大的论文中摘录的,将作为 包装 本身的一个小插图,所以对我来说,将它作为另一个小插图包含在内可能不是最好的主意,更短比这个主要的
我不确定是否还有其他 "elegant" 方法可以包含此类示例。
我会用
demo/
目录,或
- 一个
inst/examples/
目录
前者被demo()
使用,并且在Writing R Extensions中有一些额外的要求,后者更简单。
最后你当然只是写一个小插图文档......
我想知道将带有示例的 R 脚本附加到 R 包的最佳做法是什么。我指的是带有示例的 R 脚本,例如:
- 超出简单函数 运行 示例(例如带有可视化图),有 10-30 行代码,因此对我来说太长了,无法将它们作为 "Example" 在包文档中
- 是从较大的论文中摘录的,将作为 包装 本身的一个小插图,所以对我来说,将它作为另一个小插图包含在内可能不是最好的主意,更短比这个主要的
我不确定是否还有其他 "elegant" 方法可以包含此类示例。
我会用
demo/
目录,或- 一个
inst/examples/
目录
前者被demo()
使用,并且在Writing R Extensions中有一些额外的要求,后者更简单。
最后你当然只是写一个小插图文档......