检查DESCRIPTION元信息...注意

Question

我正在 R 中开发一个包，当我运行 devtools::check() 时，我收到以下注释。

checking DESCRIPTION meta-information ... NOTE Malformed Description field: should contain one or more complete sentences.

我没有在描述中使用我的包名或包这个词。我也使用完整的句子进行描述，但我反复收到此注释。所以我想知道在这种情况下完整的句子是什么意思。

Answer 1

尝试在句子末尾添加句点，即将现有的描述字段变为Functions to analyze methylation data can be found here. Highlight of this workflow is the comprehensive quality control report.

我总是觉得有点奇怪，描述字段不应该包含“包”这个词或包的名称......并且还需要完整的句子（需要主语和动词，前导如果您希望您的介绍性句子有一个主题而不使用禁止词，那么语法上非常尴尬的结构。）我很确定从语法上讲，很少有软件包在其描述字段中具有真正“完整”的句子。

我很确定它只是检查大写字母和句点，为了安全起见，我会避免使用任何特殊字符。

我在 CRAN 上的包的描述字段是 Reads river network shape files and computes network distances. Also included are a variety of computation and graphical tools designed for fisheries telemetry research, such as minimum home range, kernel density estimation, and clustering analysis using empirical k-functions with a bootstrap envelope. Tools are also provided for editing the river networks, meaning there is no reliance on external software. 绝对不是最好的，但显然它有效并且 CRAN 喜欢它！

Answer 2

在详细说明的末尾添加句号/句点/点 (.) 将删除此警告。