首页 > 解决方案 > 避免在DESCRIPTION文件和roxygen包文档中重复包描述

问题描述

在制作 R 包时,遵循https://r-pkgs.org/index.html的建议,您似乎需要将包描述放在两个不同的地方。一次,在文件的Description字段中DESCRIPTION在此处描述),第二次在将被解析的包文档中roxygen2在此处描述)。对于包文档,我知道这对其他东西很有用,例如@import语句,但你仍然需要一个@description部分,devtools::check()如果你不这样做会抱怨。

但是,在我看来,这似乎是相同的信息:对您的包裹的简短但多句的描述。我的理解正确吗?如果是,有没有办法只写一次描述,并在包构建过程中复制它?如果不是,应该放在每个位置的文本有什么区别?

标签: rr-package

解决方案


推荐阅读