检查描述元信息.备注

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.。

我一直觉得有点奇怪的是，Description字段不应该包含" package“这个词，或者包的名称...and也需要完整的句子(这需要一个主语和一个动词，如果你想让你的介绍性句子有一个主语而不使用”no-no“的话)，这会导致语法上非常笨拙的结构。我确信，从语法上讲，很少有软件包在其描述字段中有真正“完整”的句子。

我非常肯定，它只是检查大写字母和句号，我会避免任何特殊的字符，只是为了安全起见。

我在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

在描述细节的末尾添加一个完整的停止符号/句点/点(.)将删除此警告。