首页 > 解决方案 > 如何在 R 包的手册中包含 Authors@R?

问题描述

我有以下描述文件作为我的 R 包的一部分

Package: blah
Title: What the Package Does (one line, title case)
Version: 0.0.0.9000
Authors@R: person("Jon", "Snow", email = "jon.snow@jonsnow.ac.uk", role = c("aut", "cre"))
Description: What the package does (one paragraph).
Depends: R (>= 3.5.1)
License: What license is it under?
Encoding: UTF-8
LazyData: true
RoxygenNote: 6.1.0.9000

我已经记录了我的代码,并希望制作一份随附的手册。在上一篇文章中,人们提到了使用该命令 R CMD Rd2pdf <work directory>,我设法制作了一本手册。

问题是,在我的手册中,记录 R 主题之前的那一点没有显示作者,而是显示其他所有内容。我已经安装了诸如devtoolsknitr和. 任何建议将不胜感激。roxygen2testthat

标签: rpackagemanual

解决方案


如果要包含多个作者,则必须将所有人员包装在c().

例如,参见sf 的说明,它看起来像这样:

Authors@R: 
  c(person(given = "Edzer",
           family = "Pebesma",
           role = c("aut", "cre"),
           email = "edzer.pebesma@uni-muenster.de",
           comment = c(ORCID = "0000-0001-8049-7069")),
    person(given = "Jeroen",
           family = "Ooms",
           role = "ctb",
           comment = c(ORCID = "0000-0002-4035-0289")),
    person(given = "Kirill",
           family = "Müller",
           role = "ctb"))

如果只有一位作者,您可以简单地写:

Author: Lax Chan

推荐阅读