代码之家 › 专栏 › 技术社区 › Marta Karas

R包中readme和vignette的用途有什么区别?

vignette readme documentation r

Marta Karas · 技术社区 · 6 年前

我有一个 R 我将要提交给Cran的Github上的包。到目前为止,该包有一个扩展的readme.md文档,其中显示:

用于Github用户 ,我认为将这些放到readme.md比vignette更吸引人,因为当用户查看包的repo时,vignette会出现。

当我处于 把包裹移到起重机上 ,我希望有与当前readme.md中几乎相同的内容,以vignette的形式提供。

问题:将readme.md的近1-1副本复制到vignette中,保留两者,同时更新github repo以获得该vignette,然后像这样提交给cran,这是正确的做法吗?或者:它会造成不应该发生的重复?(那我该怎么办?)

1 回复 | 直到 6 年前

Dirk is no longer here 6 年前

是的,我认为这不是不寻常的。你

以及 相同的 在这三个实例中,标记文本也可以使用。

在任何情况下,都没有规则反对。另外,如果你不知道的话,这对于专注和专注的人来说是个很好的问题。 r-package-devel 与包装有关的邮件清单。

推荐文章

Alvaromon · 如何使用ReSharper获取C#样式的三斜杠注释++

6 年前

Shepmaster Tim Diekmann · 如何基于功能标志有条件地执行模块级doctest?

6 年前

depaulagu · react本机文档是如何制作的?

7 年前

yearntolearn · R包命名空间

7 年前

Jean-Baptiste Yunès · 如何在XCode中记录Swift函数的参数标签和非参数名称?

7 年前

Dimebag · dict的Python NumPy风格文档

7 年前

m00am · 如何对使用板条箱特性的函数进行doctest?

7 年前

zython Hiery Nomus · Aiohttp errno代码文档?Errno-2/111/113/104/101[关闭]

7 年前

userMod2 · 节点-遍历JS文件的文件夹并提取某些位[关闭]

7 年前

ian · ri中记录的关键字方法参数在哪里?[已关闭]

7 年前