97得票1回答
Roxygen文档中的任意部分

Roxygen似乎是这样工作的:第一行是\title,剩下的全部在\details中,而且任何@foo指令都会处理这些内容。但R文档比这更丰富。我可以在.Rd文件中使用"\section{Llamas}{Are they ungulates?}"。 但是我无法让Roxygen做除了将所有内容...

65得票3回答
如何使用roxygen文档化数据集?

在roxygen过程中,是否可以将.R文件包含在数据目录中? 我已经将多个.R文件放入数据目录中。当它们通过data()被调用时,它们会读取原始数据文件并执行一些转换。

61得票2回答
在使用Roxygen进行文档编写时:如何在@details中创建一个项目化列表?

如何在roxygen2中添加项目符号列表的适当语法,例如在@details部分中?我能创建一个latex列表环境吗?似乎换行符被简单地忽略了,即#' @details text describing parameter inputs in more detail #' #' parameter...

60得票2回答
一个.Rd文件中有多个函数

简短版:我能使用roxygen模拟stats包中Normal的文档吗? 详细版:我正在开发一个包,并试图通过将具有共同输入/参数的多个函数收集在一个标题下,使文档更易读,这将是对该组的通用引用。每个函数仍应独立地提供给最终用户。 我以Normal的文档为灵感,其中提供了许多与正态分布相关的...

57得票2回答
Roxygen2 - 如何正确地记录 S3 方法

我已经阅读了Roxygen2 PDF和这个网站,但是我不知道@method @S3method @export之间的区别,也不知道如何使用它们来正确记录S3方法。 我已经准备了下面的示例以供讨论: 我应该如何正确记录这些内容? 如何模拟文档中 ?print 和其他通用函数的用例,这些用例显示...

49得票3回答
如何使用Roxygen正确记录来自不同包的通用S3方法?

我正在编写一个新类surveyor,其中定义了一个print方法print.surveyor的包。我的代码可以正常工作,并且我使用Roxygen进行内联文档记录。但是,命令R CMD check会发出警告: 在文档对象'print.surveyor'中具有用法但未在代码中出现的函数/方...

49得票1回答
roxygen2会自动为"Imports:"包写入NAMESPACE指令吗?

问题简述 如果我想要导入包,是否必须手动在我的NAMESPACE文件中编写import()指令?即使我已将它们列在描述文件的 "Imports:" 中,看起来 roxygen2 也不会自动完成该操作。 详细版 这是一个相当愚蠢的问题,但我之所以问,是因为答案对我来说不明显。 我使用ro...

43得票4回答
在更新软件包的新版本中重命名函数时,有最佳/推荐实践要遵循吗?

我正在更新一个旧软件包,并缩短了一些非常长的函数名称。如何让用户知道旧函数已被弃用? 我使用 roxygen2 记录所有内容,所以我想知道是否应该使用 #' @alias ? 你有什么想法吗?

42得票4回答
RStudio能否自动生成函数的roxygen模板?

RStudio是否支持任何自动化roxygen模板创建? 在Emacs-ESS中,按下“ C-x C-o ”将为函数生成一个roxygen模板。例如,它会自动转换以下内容:foo <- function(x,y) x+y 变成这样:##' .. content for \descrip...

40得票2回答
当我编写自己的R软件包时,似乎无法正确导入其他软件包。

好的,这是我第一次尝试编写一个R软件包,但现在卡住了。下面是我创建软件包的方式:package.skeleton("pkg",code_files=some.filenames) roxygenize("okg") 我正在使用roxygen2,并在我的"pkg-package.R"文件中使用以...