r - 在 R Markdown 中使用 citation() 自动生成 R 包的参考书目

问题描述

我想引用一个项目中使用的 R 包，但由于它们数量众多，我认为创建两个单独的参考部分是个好主意：一个包含我的特定域的引用，另一个包含 R 的引用包。

我的第一个想法是检查我是否可以在 .bib 文件中一次导出所有使用的包的引用，但我不确定 R Markdown 是否可以处理 .bib 文件和特定于我的论文的参考书目域和 R 包的 .bib 文件。

由于函数citation()或toBibtex()生成 Bibtex 引用，我认为可以直接在 .Rmd 文件中使用这些函数生成专用于 R 包的参考部分。但是，当这些命令包含在带有 R Markdown 的块中时，似乎无法自动格式化引用。

这是我正在尝试做的事情的可重现示例：

---
title: "Cite R packages"
author: ""
date: "01/02/2020"
output: pdf_document
bibliography: test.bib
---

This is a citation of a paper: @mayer2011.

# Bibliography {-}
\setlength{\parindent}{-0.2in}
\setlength{\leftskip}{0.2in}
\noindent
<div id="refs"></div>
```{r refmgr references, results="asis", echo=FALSE}
# Print
```
\setlength{\parindent}{0in}
\setlength{\leftskip}{0in}
\setlength{\parskip}{0pt}

# Bibliography for R packages {-}
```{r}
citation("dplyr")
toBibtex(citation("dplyr"))
```

这是内容test.bib：

@article{mayer2011,
  title = {Notes on {{CEPII}}'s {{Distances Measures}}: {{The GeoDist Database}}},
  shorttitle = {Notes on {{CEPII}}'s {{Distances Measures}}},
  journal = {SSRN Electronic Journal},
  doi = {10.2139/ssrn.1994531},
  author = {Mayer, Thierry and Zignago, Soledad},
  year = {2011}
}

关于如何轻松地将 R 包的引用包含在单独的参考部分中的任何想法？

编辑：见这里另一种解决方案。

标签： rr-markdown

解决方案

这里有两个独立但相关的问题：

如何以编程方式引用包
如何在 Markdown 文档中有两个单独的参考部分

两者都有解决方案，我将依次介绍：

如何以编程方式引用包

这里的关键是意识到 Pandoc 只会在 R 代码块运行后编写您的文档。这使您有机会以编程方式编写.bib文件作为 R markdown 文档的一部分，该文件仅在文档创建阶段由 Pandoc 读取。

它还取决于能够.bib在参考书目中使用两个文件。这也是可能的，但我们现在将离开这个问题。

您需要的是一个函数，它将获取包名称，获取 bibtex 格式的引文，将它们粘贴在一起并将它们保存为.bib文件。我在这里编写了一个示例函数来展示如何做到这一点。

此函数必须处理吐出多个 bibtex 引用的包，它会自动在 bibtex 中插入包名称，以便您可以使用 @packagename 在降价中引用任何包。它使用非标准评估和...参数，因此您不需要引用包名称或将它们包装在c()：

citeR <- function(...)
{
  packages <- unlist(lapply(as.list(match.call()), deparse))[-1]
  Rbibs <- ""

  for(package in packages)
  {
    Rbib <- capture.output(print(citation(package), bibtex = T))    
    Rbib <- mapply(function(x, y) Rbib[x:y], 
                   grep("  @.+[{]", Rbib), 
                   which(Rbib == "  }"))

    if(class(Rbib) == "matrix"){
      Rbib[1, 1] <- gsub(",", paste0(package, ","), Rbib[1, 1])
      Rbib <- paste0(Rbib, collapse = "\n")
    } else {
      Rbib <- unlist(lapply(Rbib, function(x) {
                               x[1] <- gsub(",", paste0(package, ","), x[1]); 
                               x <- paste0(unlist(x), collapse = "\n")
                               return(x)
                             }))
    }

    if(length(Rbib) > 1) {
      if(any(grepl("@Manual", Rbib))) {
        Rbib <- Rbib[grep("@Manual", Rbib)][1]
      } else {
        Rbib <- Rbib[1]}}

    Rbibs <- paste(Rbibs, Rbib, sep = "\n\n")
  }

  writeBin(charToRaw(utf8::as_utf8(Rbibs)), "packages.bib")
}

要使用它，您只需将其放入带有 echo = FALSE 的 R 块中并执行以下操作：

citeR(dplyr, ggplot2, knitr, pROC)

如何有两个参考部分

我不能把这部分答案归功于我从这里得到的。它比第一部分更复杂。首先，您必须使用 lua 过滤器，这需要最新版本的 rmarkdown 和 Pandoc，因此请更新到最新版本，否则可能无法正常工作。

lua 过滤器的基本原理在提供的链接中进行了描述，但我将在此处包含它并完全感谢@tarleb。您必须将以下文件保存multiple-bibliographies.lua在与降价相同的目录中：

-- file: multiple-bibliographies.lua

--- collection of all cites in the document
local all_cites = {}
--- document meta value
local doc_meta = pandoc.Meta{}

--- Create a bibliography for a given topic. This acts on all divs whose ID
-- starts with "refs", followed by nothings but underscores and alphanumeric
-- characters.
local function create_topic_bibliography (div)
  local name = div.identifier:match('^refs([_%w]*)$')
  if not name then
    return nil
  end
  local tmp_blocks = {
    pandoc.Para(all_cites),
    pandoc.Div({}, pandoc.Attr('refs')),
  }
  local tmp_meta = pandoc.Meta{bibliography = doc_meta['bibliography' .. name]}
  local tmp_doc = pandoc.Pandoc(tmp_blocks, tmp_meta)
  local res = pandoc.utils.run_json_filter(tmp_doc, 'pandoc-citeproc')
  -- first block of the result contains the dummy para, second is the refs Div
  div.content = res.blocks[2].content
  return div
end

local function resolve_doc_citations (doc)
  -- combine all bibliographies
  local meta = doc.meta
  local orig_bib = meta.bibliography
  meta.bibliography = pandoc.MetaList{orig_bib}
  for name, value in pairs(meta) do
    if name:match('^bibliography_') then
      table.insert(meta.bibliography, value)
    end
  end
  doc = pandoc.utils.run_json_filter(doc, 'pandoc-citeproc')
  doc.meta.bibliography = orig_bib -- restore to original value
  return doc
end

return {
  {
    Cite = function (c) all_cites[#all_cites + 1] = c end,
    Meta = function (m) doc_meta = m end,
  },
  {Pandoc = resolve_doc_citations,},
  {Div = create_topic_bibliography,}
}

要使其正常工作，您的 YAML 标头应如下所示：

---
title: "Cite R packages"
author: ''
date: "01/02/2020"
output:
  pdf_document:
    pandoc_args: --lua-filter=multiple-bibliographies.lua
bibliography_software: packages.bib
bibliography_normal: test.bib
---

请注意，packages.bib当您开始编织文档时不需要存在，因为它将在调用 Pandoc 之前创建。

要插入参考部分，您需要将这些 html 片段放在降价的适当位置：

<div id = "refs_normal"></div>

和

<div id = "refs_software"></div>

把它们放在一起

我知道这已经是一个很长的答案，但我认为最好包含一个完整的工作示例并显示 pdf 输出：

---
title: "Cite R packages"
author: ''
date: "01/02/2020"
output:
  pdf_document:
    pandoc_args: --lua-filter=multiple-bibliographies.lua
bibliography_software: packages.bib
bibliography_normal: test.bib
---

This is a citation of a paper: @mayer2011.
This is a citation of an R package @dplyr
And another @ggplot2 and another @knitr plus @pROC

# Bibliography{-}
\setlength{\parindent}{-0.2in}
\setlength{\leftskip}{0.2in}
\noindent
<div id = "refs_normal"></div>
\setlength{\parindent}{0in}
\setlength{\leftskip}{0in}
\setlength{\parskip}{0pt}

# Software used{-}
\setlength{\parindent}{-0.2in}
\setlength{\leftskip}{0.2in}
\noindent
<div id = "refs_software"></div>
\setlength{\parindent}{0in}
\setlength{\leftskip}{0in}
\setlength{\parskip}{0pt}

```{r citeR, echo=FALSE}

citeR <- function(...)
{
  packages <- unlist(lapply(as.list(match.call()), deparse))[-1]
  Rbibs <- ""

  for(package in packages)
  {
    Rbib <- capture.output(print(citation(package), bibtex = T))

    Rbib <- mapply(function(x, y) Rbib[x:y], 
                   grep("  @.+[{]", Rbib), 
                   which(Rbib == "  }"))

    if(class(Rbib) == "matrix")
    {
      Rbib[1, 1] <- gsub(",", paste0(package, ","), Rbib[1, 1])
      Rbib <- paste0(Rbib, collapse = "\n")
    }
    else
    {
      Rbib <- unlist(lapply(Rbib, function(x) {
                               x[1] <- gsub(",", paste0(package, ","), x[1]); 
                               x <- paste0(unlist(x), collapse = "\n")
                               return(x)
                             }))
    }

    if(length(Rbib) > 1)
    {
      if(any(grepl("@Manual", Rbib)))
      {
        Rbib <- Rbib[grep("@Manual", Rbib)][1]
      }
      else
      {
        Rbib <- Rbib[1]
      }
    }

    Rbibs <- paste(Rbibs, Rbib, sep = "\n\n")
  }

  writeBin(charToRaw(utf8::as_utf8(Rbibs)), "packages.bib")
}

citeR(dplyr, ggplot2, knitr, pROC)

```#

和 test.pdf 看起来像这样：