r - R包中的README和vignette之间的目的区别是什么？

Question

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

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

出于 GitHub users 的目的，我认为将这些放到 README.md 中比 vignette 更有吸引力，因为它会在用户查看包的 repo 时出现。

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

问题：将几乎 1-1 的 README.md 副本制作成一个小插图，保留两者，更新 GitHub 存储库以拥有这个小插图，然后提交给 CRAN，这是一种正确的行为方式吗？或者：它会造成不应该发生的重复？（那我应该怎么做？）

Answer 1

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

• 在 GitHub 上有一个 README.md 作为（源）包 repo 的“公众面孔”
• 想要一个包装摘要，其中一个小插曲可以很好地发挥作用
• 甚至可能最终得到一个包网站或摘要

并且相同的降价文本也可以在所有三种情况下使用。

无论如何，没有任何规则反对它。此外，如果您不知道，这对于r-package-devel与包装有关的专门和集中的邮件列表来说是一个很好的问题。