R包文档中一起列出的相关函数答案

【问题标题】：Related functions listed together in R package documentationR包文档中一起列出的相关函数
【发布时间】：2018-05-26 06:00:21
【问题描述】：

我正在开发一个 R 包，其中的功能属于逻辑组；广义地说，“输入”、“数据处理”、“分析”、“输出”、“信息”和“实用程序”。我希望我的包索引按顺序分成这些主要标题，每个组中的功能按字母顺序列出。我不想要像多个级联级别这样的傻事；一级就可以了。

R 包文档系统（否则它很漂亮——谢谢大家！）给我一个索引，顶部有小插图和说明，然后是按字母顺序排列的所有函数。我认为像@family 或@describeIn 这样的roxygen2 标签可以解决问题，但事实并非如此。我还注意到一些包的索引按初始函数字母划分，但是快速查看 Github 上的源代码并没有发现任何有用的信息。除了 this 之类的黑客攻击之外，谷歌搜索和 Stackexchang 没有发现任何东西，它指的是 lattice。

我不敢相信我是 R 历史上第一个想要这样做的人！我通常认为在开源包中听起来合理的事情会很容易或至少是可能的——它们通常是由合理的人编写的——但我在这里不知所措。

【问题讨论】：

我觉得做不到。如果我在你里面，我会关注其他包的做法，例如raster（参见cran.r-project.org/web/packages/raster/raster.pdf）：一个按主题总结的所有功能的重要介绍。

标签： r documentation packages roxygen2

【解决方案1】：

我还没有找到一种方法来创建按组对功能排序的文档。我喜欢@nicola 指出的光栅示例，其中介绍了按主题分组的功能。我并不完全清楚他们是否必须手动输入这个额外的文档，所以我想出了一个使用 roxygen2 @family 的 hack（与 lattice 文档相关），并将在顶部生成一个类似函数的列表文档自动生成。给该组一个@family 标签，并确保给该组中的所有其他函数同样的@family 标签：

#' Heading A
#'
#' Functions used for "a" purpose
#' @name A1 
#' @family a functions
NULL

#' Heading B
#' 
#' Functionsed used for "b" purpose
#' @name A2
#' @family b functions
NULL

#' foo
#' @param x
#' @family a functions
foo <- function(x) x * 10

【讨论】：