Question

我正在开发一个R包，其中的功能属于逻辑组;广泛地说，“输入”，“数据分析”，“分析”，“输出”，“信息”和“实用程序”。我希望我的包索引按顺序拆分为这些主要标题，每个组中的函数按字母顺序列出。我不想要任何像多个级联级别那样愚蠢的东西;一级将没问题。

R包文档系统（这是一个美丽的东西 - 谢谢大家！）给我一个带有晕影和顶部描述的索引，然后按字母顺序排列所有函数。我认为像@family或@describeIn这样的roxygen2标签可以解决这个问题，但事实并非如此。我还注意到有些软件包的索引被初始函数字母拆分了，但是快速查看Github上的源代码并没有提出任何有用的信息。谷歌搜索和堆栈交换不会发现除this之类的一些黑客之外的任何内容，这些黑客引用lattice。

我无法相信我是R历史上第一个想要这样做的人！我通常认为听起来合理的东西在开源软件包中很容易或者至少是可能的 - 它们通常由合理的人写 - 但我在这里不知所措。

Answer 1

我还没有找到一种方法来创建按组排序功能的文档。我喜欢@nicola指出的光栅示例，其中介绍了按主题分组的功能。我不清楚他们是否必须手工输入这些额外的文档，所以我想出了一个使用roxygen2 @family的hack（与格子文档相关）并将在顶部生成一个类似函数的列表。文档自动。给该组一个@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

R包文档中列出的相关函数

1 个答案: