繁体   English   中英

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

[英]Format for adding references in R package DESCRIPTION?

我刚刚向 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.

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

我从 Julia Silge 的博客文章开始

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

这里有些例子:

给定蛋白质多序列比对,评估沿序列长度的替换效果是一项艰巨的任务。 “aaSEA”软件包旨在帮助研究人员快速分析由蛋白质中单个、多个和相关氨基酸取代引起的特性变化。 从多序列比对中识别共同进化位置的方法在:Pelé et al., (2017) doi:10.4172/2379-1764.1000250 中有描述。

要么

使用近似贝叶斯计算 (ABC) 在贝叶斯框架下基于失效时间数据估计累积损坏(负载持续时间)模型的参数。 评估随机负载曲线下的长期可靠性。 Yang、Zidek 和 Wong (2019) doi:10.1080/00401706.2018.1512900。

对“https”使用类似的过滤器显示(不出所料)比学术参考文献更通用的网站链接,但例如:

专为研究用声学标签标记的动物预计\\n 移动通过接收器阵列而设计。 该软件包结合了自动分类和检查\\n 动物运动的优点,以及用户对偏离预期\\n 行为的标签进行干预的可能性。 三个分析函数(explore()、migration() 和residency())\\n 允许用户以系统的方式分析他们的数据,从而轻松比较\\n 不同研究的结果。\\n CJS 计算基于佩里等人。 (2012) https://www.researchgate.net/publication/256443823_Using_mark-recapture_models_to_estimate_survival_from_telemetry_data

ArXiv(目前共有 17962 个包含此类链接的软件包,其中只有 24 个):

提供用于模型拟合和选择随机图的广义超几何集合 (gHypEG) 的函数。\\n 要了解如何使用它,请查看小插图以获取快速教程。\\n 请参考其用法为 Casiraghi, G., Nanumyan, V . (2019) doi:10.5281/zenodo.2555300\\n 以及下面列出的相关参考文献。\\n 该软件包基于苏黎世联邦理工学院系统设计主席开发的研究。\\n Casiraghi, G. , Nanumyan, V., Scholtes, I., Schweitzer, F. (2016) arXiv:1607.02441。\\n Casiraghi, G., Nanumyan, V., Scholtes, I., Schweitzer, F. (2017) doi:10.1007/ 978-3-319-67256-4_11.\\n Casiraghi, G., (2017) arxiv:1702.02048\\n Casiraghi, G., Nanumyan, V. (2018) arXiv:1810.06495.\\n Brandasirag, G., Nanumyan, V., Schweitzer, F. (2019) doi:10.1145/3341161.3342926\\n Casiraghi, G. (2019) doi:10.1007/s41109-019-0241-1。

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM