R包中的自述文件和vignette之间的目的区别是什么？

我在GitHub上有一个

R

包，我要提交给CRAN。到目前为止，该软件包有一个广泛的README.md文档，其中显示：

• 包核心功能执行示例
• 包演示执行示例
• 一些基准测试结果

对于GitHub用户而言，我认为将这些内容放到README.md比vignette更有吸引力，因为当用户查看包的回购时，vignette会显示出来

当我即将将软件包移动到CRAN时，我希望以小插曲的形式提供与README.md中当前内容几乎相同的内容

---

问题：将几乎1-1份的README.md复制成一个小插曲，保留两者，更新GitHub repo以获得这个小插曲，然后提交给CRAN，这是一种正确的做法吗？或者：它会造成不应该发生的重复？（那我该怎么做呢？

是的，我认为这并不少见。你

• 在GitHub上有一个README.md作为（源）包回购的“公众形象”
• 想要一个小结可以很好地服务的包摘要吗
• 甚至可能最终得到一个webite或summary包

同样的降价文本也适用于所有三种情况

---

在任何情况下都没有反对的规则。此外，如果您不知道，这对于专注于包装的

r-package-devel

邮件列表来说是一个好问题。

我会提出一个替代方案-使用

库（pkgdown）

为您的包创建一个网站。它从您的自述和vignette构建站点，并将其托管在github页面上。例如，以我的

mapdeck

library-为例，这里是，vignette现在是“入门”页面，而不是reallty，因为它不能帮助需要本地资源的包用户。外部网站需要连接。如果您仔细阅读编写R扩展以理解本文档的精神，我觉得您会同意R Core首先描述的是外部资源，尽管这些资源在某些开发人员群体中很常见。非常感谢您提供有关

pkgdown

的提示！我不知道，我发现它很有用！这是一个很好的答案！非常感谢关于

r-package-devel

的提示。谢谢不客气，你可以接受答案。我也是该列表的创建者/管理员之一，也是可能批准您的第一篇帖子（b/c垃圾邮件）的人之一，之后您可以自由发布更多内容：）