R person 人员

说明

用于保存姓名和电子邮件地址等人员信息的类和实用方法。

用法

person(given = NULL, family = NULL, middle = NULL,
       email = NULL, role = NULL, comment = NULL,
       first = NULL, last = NULL)

as.person(x)
## Default S3 method:
as.person(x)

## S3 method for class 'person'
format(x,
       include = c("given", "family", "email", "role", "comment"),
       braces = list(given = "", family = "", email = c("<", ">"),
                     role = c("[", "]"), comment = c("(", ")")),
       collapse = list(given = " ", family = " ", email = ", ",
                       role = ", ", comment = ", "),
       ...,
       style = c("text", "R")
)

## S3 method for class 'person'
toBibtex(object, escape = FALSE, ...)

参数

given	具有给定名称或其列表的字符向量。
family	带有姓氏的字符串或其列表。
middle	带有折叠中间名的字符串。已弃用，请参阅详细信息。
email	给出 e-mail 地址(每个)的字符串(或向量)或其列表。
role	指定人员角色的字符向量(请参阅详细信息)或其列表。
comment	提供注释的字符串(或向量)或其列表。
first	给出名字的字符串。已弃用，请参阅详细信息。
last	给出姓氏的字符串。已弃用，请参阅详细信息。
x	as.person 泛型的对象； as.person 默认方法的字符串；否则是"person" 类的对象。
include	给出格式化时要包含的字段的字符向量。
braces	字符列表(请参阅详细信息)。
collapse	字符列表(请参阅详细信息)。
...	目前没有使用。
style	指定打印样式的字符串，"R" 产生 R 代码的格式。
object	一个R从类继承的对象"person".
escape	指示非 ASCII 字符是否应转换为 LaTeX 转义序列的逻辑。

细节

"person" 类的对象可以保存任意正数个人的信息。这些可以通过使用列表参数调用 person() 来获得，或者首先创建代表单个人的对象并通过 c() 组合这些对象来获得。

format() 方法将有关人员的信息折叠为字符向量(每个人一个字符串)：选择 include 中的字段，每个字段使用 collapse 的相应元素折叠为字符串，随后使用相应的 “embraced” 折叠为字符串。 braces 的元素，最后折叠成一个由空格分隔的字符串。如果 braces 和/或 collapse 未指定所有字段的字符，则会估算用法中显示的默认值。如果collapse 是FALSE 或NA，则相应字段不会折叠，但仅使用第一个元素。 print() 方法调用 format() 方法并打印结果，toBibtex() 方法创建合适的 BibTeX 表示形式。

Person 对象可以按字段(使用 $ )或位置(使用 [ )进行下标。

as.person() 是一个通用函数。它的默认方法尝试反转默认的人员格式，并且还可以处理由逗号或"and"(带有适当的空格)折叠的格式化人员条目。

个人名称相当棘手，例如 https://en.wikipedia.org/wiki/Personal_name 。

"person" 类的当前实现(从 R 2.12.0 开始)使用给定(包括中间名)和姓氏的概念，分别由 given 和 family 指定。早期版本使用基于名字、中间名和姓氏的方案，适合大多数西方文化，其中名字在姓氏之前，但不通用，因为其他一些文化将其放在姓氏之后，或者不使用姓氏。为了顺利过渡到新方案，参数 first 、 middle 和 last 仍然受支持，但它们的使用已被弃用，并且不得与相应的新样式参数结合使用。对于非自然人(例如机构、公司等)，适合使用 given (但不是 family )作为名称，例如 person("R Core Team", role = "aut") 。

新方案还增加了指定的可能性角色基于 MARC 相关代码列表的子集(https://www.loc.gov/marc/relators/relaterm.html)。在创作中赋予人物角色时R包，建议使用以下方式。

"aut"

(作者)用于对包做出重大贡献并应出现在包引用中的完整作者。

"com"

(编译器)用于收集代码(可能是其他语言)但没有对包做出进一步实质性贡献的人。

"cph"

(版权持有者)供所有版权持有者使用。这是一个法律概念，因此应使用机构或法人团体的法定名称。

"cre"

(创建者)用于包维护者。

"ctb"

(贡献者)用于做出较小贡献(例如代码补丁等)但不应出现在包引用中的作者。

"ctr"

(承包商)用于已签约编写包(部分)的作者，因此不拥有知识产权。

"dtc"

(数据贡献者)用于为包贡献数据集的人员。

"fnd"

(资助者)用于为包的开发提供财务支持的个人或组织。

"rev"

(审阅者)用于负责审阅包(部分)的个人或组织。

"ths"

(论文顾问)如果该包是论文的一部分，请用于论文顾问。

"trl"

(翻译器)如果 R 代码是从另一种语言(通常是 S)翻译而来，则用于 R 的翻译器。

在旧方案中，人员对象用于单个人员，单独的 "personList" 类及其相应的创建者 personList() 用于这些对象的集合。新方案采用单个类来获取有关任意正数人员的信息，从而消除了对 personList 机制的需要。

comment 字段可用于“arbitrary” 有关人员的附加信息。名为"ORCID"的元素将被用来给出ORCID标识符(更多信息参见https://orcid.org/)，并通过print()和format()方法显示为相应的URI(参见下面的示例)。

值

person() 和 as.person() 返回类 "person" 的对象。

例子

## Create a person object directly ...
p1 <- person("Karl", "Pearson", email = "pearson@stats.heaven")

## ... or convert a string.
p2 <- as.person("Ronald Aylmer Fisher")

## Combining and subsetting.
p <- c(p1, p2)
p[1]
p[-1]

## Extracting fields.
p$family
p$email
p[1]$email

## Specifying package authors, example from "boot":
## AC is the first author [aut] who wrote the S original.
## BR is the second author [aut], who translated the code to R [trl],
## and maintains the package [cre].
b <- c(person("Angelo", "Canty", role = "aut", comment =
         "S original, <http://statwww.epfl.ch/davison/BMA/library.html>"),
       person(c("Brian", "D."), "Ripley", role = c("aut", "trl", "cre"),
              comment = "R port", email = "ripley@stats.ox.ac.uk")
     )
b

## Formatting.
format(b)
format(b, include = c("family", "given", "role"),
   braces = list(family = c("", ","), role = c("(Role(s): ", ")")))

## Conversion to BibTeX author field.
paste(format(b, include = c("given", "family")), collapse = " and ")
toBibtex(b)

## ORCID identifiers.
(p3 <- person("Achim", "Zeileis",
              comment = c(ORCID = "0000-0003-0918-3766")))

也可以看看

citation