在R包描述中添加引用的格式？

Question

我刚刚向 CRAN 提交了一个 R 包。我收到了这条评论：

If there are references describing the methods in your package, please add these in the description field of your DESCRIPTION file in the form
authors (year) <doi:...>
authors (year) <arXiv:...>
authors (year, ISBN:...)
or if those are not available: <https:...>
with no space after 'doi:', 'arXiv:', 'https:' and angle brackets for auto-linking.
(If you want to add a title as well please put it in quotes: "Title") 

但我认为

description

字段仅限于一个段落，这意味着除了该字段中的单个段落之外，您不能包含其他文本。所以我不确定在描述字段中包含引用的确切格式是什么。我的猜测如下，但此格式返回一条注释，指出描述格式错误。

Description: Text describing the package, blah blah blah.
    More text goes here, etc etc etc.
    Foo, B., and J. Baz. (1999) <doi:23232/xxxxx.00>
    Smith, C. (2021) <https://something.etc/foo>

运行时返回注释

R CMD check

:

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

这个问题是相关的，但没有令人满意的答案，所以我再次询问。

Answer 1

我从 Julia Silge 的博客文章开始这里：

cran <- tools::CRAN_package_db()
desc_with_doi <- grep("doi:", cran$Description, value = TRUE)

以下是一些示例：

考虑到蛋白质多序列比对，评估沿序列长度的替换的影响是一项艰巨的任务。 “aaSEA”包旨在帮助研究人员快速分析蛋白质中单个、多个和相关氨基酸取代引起的性质变化。从多序列比对中识别共同进化位置的方法如以下所述：Pelé et al., (2017) .

或

使用近似贝叶斯计算 (ABC)，在贝叶斯框架下基于故障时间数据估计累积损坏（负载持续时间）模型的参数。评估随机负载曲线下的长期可靠性。杨、Zidek 和 Wong (2019) .

对“https”使用类似的过滤器显示（毫不奇怪）比学术参考文献更通用的网站链接，但例如：

专为需要贴有声学标签的动物的研究而设计 通过接收器阵列移动。该包结合了自动分拣和检查的优点 动物运动的可能性，用户可以对偏离预期的标签进行干预 行为。三个分析函数（explore（）、migration（）和residency（）） 允许用户以系统的方式分析他们的数据，从而轻松比较结果 不同的研究。 CJS 计算基于 Perry 等人。 (2012) .

ArXiv（目前总共 17962 个软件包中只有 24 个包含此类链接）：

提供模型拟合和随机图广义超几何系综（gHypEG）选择的函数。 要了解如何使用它，请查看小插图以获取快速教程。 请参考其用途 Casiraghi, G., Nanumyan, V. (2019) doi:10.5281/zenodo.2555300 以及下面列出的相关参考文献。 该软件包基于苏黎世联邦理工学院系统设计主席的研究开发。 Casiraghi, G.、Nanumyan, V.、Scholtes, I.、Schweitzer, F. (2016)。 Casiraghi, G.、Nanumyan, V.、Scholtes, I.、Schweitzer, F. (2017)。 卡西拉吉，G.，（2017） 卡西拉吉 (Casiraghi)，G.，纳努米扬 (Nanumyan)，V. (2018) 。 Brandenberger, L.、Casiraghi, G.、Nanumyan, V.、Schweitzer, F. (2019) 卡西拉吉，G. (2019) .

Answer 2

显然，（至少对我来说）当描述字段末尾有不适当的字符时，通常会发生此错误。我发现的合法字符是：“.”、“?”、“!”。 因此，以下描述不应引发错误：

Description: Text describing the package, blah blah blah.
    More text goes here, etc etc etc.
    Foo, B., and J. Baz. (1999) <doi:23232/xxxxx.00>
    Smith, C. (2021) <https://something.etc/foo>.