簡體   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