检查描述元信息...注意

时间:2017-04-28 20:36:27

标签: r package

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

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

我没有在说明中使用我的包名或包字。我也使用完整的句子描述,但我反复得到这个注意。所以我想知道在这种情况下完整句子意味着什么。

2 个答案:

答案 0 :(得分:5)

尝试在句子末尾添加句点,即将现有的“说明”字段转换为Functions to analyze methylation data can be found here. Highlight of this workflow is the comprehensive quality control report.

我总是觉得有点好奇,说明字段不应该包含单词" package"或者包的名称......还需要完整的句子(需要一个主语和一个动词,如果你希望你的介绍性句子有一个主题而不使用禁忌词,那么会产生非常语法笨拙的结构。)I& #39;我非常肯定从语法上来说,很少有包真正完成"完成"其描述字段中的句子。

我非常确定它只会检查大写字母和句号,而且我会避免使用任何特殊字符,只是为了安全起见。

我在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喜欢它!

答案 1 :(得分:3)

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