R语言【taxlist】——indended_list()：将层级结构输出为缩进列表

Package taxlist version 0.2.4

---

Description

将 taxlist 对象打印分类层次结构（等级和父子关系）输出为缩进列表。

---

Usage

indented_list(object, ...)

## S4 method for signature 'taxlist'
indented_list(
  object,
  filter,
  keep_children = TRUE,
  keep_parents = TRUE,
  rankless_as,
  indent = " ",
  lead_br = "",
  print = TRUE,
  author = TRUE,
  level = FALSE,
  synonyms = FALSE,
  syn_encl = c("= ", ""),
  secundum,
  alphabetical = FALSE,
  ...
)

---

Arguments

参数【object】：包含分类概念（taxonomic concepts）的一个 taxlist 对象。

参数【...】：其余参数（尚未可用）。

参数【filter】：一个字符值（可选），该值将与分类单元用法名称匹配，以生成“object”的子集。请注意，此过滤器也将应用于 synonyms，与参数“synonyms”中应用的参数无关。

参数【keep_children】：一个逻辑值，指示结果中是否应包含匹配概念的子项。

参数【keep_parents】：一个逻辑值，指示结果中是否应包含匹配概念的父级。

参数【rankless_as】：一个字符向量，指示在执行列表之前可以将无等级分类群设置为的级别（分类等级）。

参数【indent】：用于缩进的符号。该符号将乘以分类等级的深度。默认值为空格。这也可以作为命名向量提供，并为相应的分类等级提供不同的缩进符号。

参数【lead_br】：可选换行符号在缩进前行。r-markdown 文档可能需要它。

参数【print】：一个逻辑值，指示是否应在控制台中打印缩进列表 （default = TRUE）。

参数【author】：一个逻辑值，指示是否应使用姓名打印作者 （default = TRUE）。

参数【level】：一个逻辑值，指示是否应在名称之前包含级别名称（分类等级）（默认值 = FALSE）。

参数【synonyms】：一个逻辑值，指示是否应将同义词包含在接受的名称之后 （default = FALSE）。

参数【syn_encl】：长度为 2 的字符向量，包括用于括同义词的符号。第一个值将设置在同义词之前，第二个值将设置在同义词之后。

参数【secundum】：与插槽“taxonViews”中的名称匹配的字符值，该名称将打印为 secundum（分类视图）。默认情况下不打印它。

参数【alphabetical】：一个逻辑值，指示分类群是按名称还是按 ID 排序。默认值为 FALSE，因此分类群按 ID 排序。请注意，如果对象包含同名分类群，则参数 TRUE 可能无法正常工作。

---

Value

如果“print = TRUE”，则在控制台中打印缩进列表。结果是一个数据框，其中包含用于设置名称格式的元素，也可以分配给对象。

---

Examples

直接输出缩进列表：

indented_list(Easplist, "papyrus")

Cyperaceae Juss.
 Cyperus L.
   Cyperus papyrus L. 

indented_list(Easplist, "papyrus", level = TRUE, synonyms = TRUE,
    secundum = "secundum")

family Cyperaceae Juss. sec. The Plant List (2013)
 genus Cyperus L. sec. Taxonomic Name Resolution Service (2018)
   species Cyperus papyrus L. sec. African Plant Database (2012)
   = Cyperus papyrus ssp. antiquorum (Willd.) Chiov.
   = Cyperus papyrus ssp. nyassicus Chiov.