gpt4 book ai didi

r - R 包中 README 和小插图之间的目的区别是什么?

转载 作者:行者123 更新时间:2023-12-04 12:01:45 29 4
gpt4 key购买 nike

我有一个 R我即将提交给 CRAN 的 GitHub 上的包。到目前为止,该包已经有一个广泛的 README.md 文档,其中显示:

  • 包核心函数执行示例,
  • 包演示执行示例,
  • 一些基准测试结果。

  • 供 GitHub 用户使用 ,我认为将这些放在 README.md 中比小插图更有吸引力,因为它会在用户查看包的存储库时显示。

    当我在点 将包裹移至 CRAN ,我希望以小插图的形式提供与当前 README.md 中几乎相同的内容。

    问题:将 README.md 的几乎 1-1 副本制作成小插图,同时保留两者,更新 GitHub 存储库以包含此小插图,然后将其提交给 CRAN,这是一种正确的行为方式吗?或者:它会造成不应该发生的重复? (那我该怎么做呢?)

    最佳答案

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

  • 在 GitHub 上有一个 README.md 作为(源)包 repo 的“公开面孔”
  • 想要一个小插图可以很好地服务的包裹摘要
  • 甚至可能最终得到一个包网站或摘要

  • 并且相同的 Markdown 文本也可能适用于所有三种情况。

    在任何情况下,都没有反对它的规则。此外,如果您不知道,这对于专注且专注的 r-package-devel 来说是一个很好的问题。与包装有关的邮件列表。

    关于r - R 包中 README 和小插图之间的目的区别是什么?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/53808516/

    29 4 0
    Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
    广告合作:1813099741@qq.com 6ren.com