R包中的README和Vignette有什么目的区别？

Question

我在GitHub上有一个R软件包，我要提交给CRAN。到目前为止，该程序包已经包含一个扩展的README.md文档，该文档显示：

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

出于GitHub用户的目的，我认为将它们放到README.md上比装饰插图更具吸引力，因为当用户查看软件包的回购协议时，它会显示出来。

当我要将程序包移至CRAN 时，我希望获得的内容与README.md中当前的内容大致相同，都可以使用小插图的形式。

问题：将README.md的近1-1副本制作成小插图，同时保留两者，更新GitHub repo以使其也具有小插图，然后将其提交给CRAN，这是一种正确的操作方式吗？或者：是否会造成重复，不应该发生？ （那我应该如何进行？）

Answer 1

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

• 在GitHub上有一个README.md，作为（源）软件包仓库的“公开面孔”
• 想要小插图可能适合的包装摘要
• 甚至可能会得到一个打包的网站或摘要

和相同降价文字也可以在所有三种情况下使用。

在任何情况下都没有针对它的规则。另外，如果您不知道，对于与包装有关的专用r-package-devel专用邮件列表，这将是一个很好的问题。