R 包中的 README 和 vignette 之间的目的区别是什么?
What is the purpose difference between README and vignette in R package?
我在 GitHub 上有一个 R
包,我将要提交给 CRAN。到目前为止,该软件包有一个广泛的 README.md 文档,其中显示:
- 包核心功能执行示例,
- 包演示执行示例,
- 一些基准测试结果。
出于 GitHub 用户 的目的,我认为将这些放在 README.md 比小插图更有吸引力,因为它在用户查看时显示包裹的回购。
当我将包移动到 CRAN 时,我希望在表单中提供与当前 README.md 中几乎相同的内容的小插图。
问题:将 README.md 的几乎 1-1 副本复制到小插图中是否是正确的行为方式,同时保留两者,更新 GitHub 存储库以包含此小插图,并且然后提交给CRAN?或者:它会造成不应该发生的重复? (那我该怎么办?)
是的,我认为这并不罕见。你
- 在 GitHub 有一个 README.md 作为(源)包 repo
的 'public face'
- 想要一个小插图可以很好地服务的包摘要
- 甚至可能以软件包网站或摘要结尾
和相同的降价文本也可以在所有三种情况下使用。
无论如何,没有规则反对它。此外,如果您不知道,这对于专门和专注于包装的 r-package-devel
邮件列表来说是一个很好的问题。
我在 GitHub 上有一个 R
包,我将要提交给 CRAN。到目前为止,该软件包有一个广泛的 README.md 文档,其中显示:
- 包核心功能执行示例,
- 包演示执行示例,
- 一些基准测试结果。
出于 GitHub 用户 的目的,我认为将这些放在 README.md 比小插图更有吸引力,因为它在用户查看时显示包裹的回购。
当我将包移动到 CRAN 时,我希望在表单中提供与当前 README.md 中几乎相同的内容的小插图。
问题:将 README.md 的几乎 1-1 副本复制到小插图中是否是正确的行为方式,同时保留两者,更新 GitHub 存储库以包含此小插图,并且然后提交给CRAN?或者:它会造成不应该发生的重复? (那我该怎么办?)
是的,我认为这并不罕见。你
- 在 GitHub 有一个 README.md 作为(源)包 repo 的 'public face'
- 想要一个小插图可以很好地服务的包摘要
- 甚至可能以软件包网站或摘要结尾
和相同的降价文本也可以在所有三种情况下使用。
无论如何,没有规则反对它。此外,如果您不知道,这对于专门和专注于包装的 r-package-devel
邮件列表来说是一个很好的问题。