标签: roxygen2

可能重复:
在Roxygen2样式文档中转义"@"

如何在roxygen文档中使用@,如:

#' @param arg An argument that uses the symbol @

这会在你跑步时发出警告,roxygenize而不是把@放在.Rd文件中.

我想在记录R函数的上下文中在等式中排版矩阵.事实上,amsmath默认情况下R文档不可用,并且eqnarray不起作用,因为\deqn已经打开了相应的数学环境.

那么,专业人士如何做呢？通过tabular或一些这样的？

我在整理包装时遇到了麻烦.这是几个月前的最后一次工作,我从未检查过,所以不确定我添加的代码片段是否破坏了它,如果我的系统配置发生了变化,或者roxygen2发生了变化.

我已经尝试通过它从上面的目录devtools::document中的--vanillaR sesssion roxygen2::roxygenize('taRifx')从roxygenize('.')项目基目录调用它,尝试以root身份运行,以防它是权限的事情,等等.

这是RStudio版本:

==> roxygenize('.', roclets=c('rd'))

* checking for changes ... ERROR

Error in file(con, "r") : cannot open the connection

包裹代码在这里:

https://github.com/gsk3/taRifx

我该如何解决？

我正在开发一个程序包，其中多个不同的函数具有相同参数的子集。这意味着我有很多重复的论据文档。在许多情况下，这些函数不能在逻辑上分组在一起，即，将它们全部放在同一个.Rd文件中是没有意义的。如果有文档，有办法避免这种重复吗？是否具有主.Rd文件，其组件可以选择性地包含在其他roxygen块中？

我在我的R包中使用rogyxen2模板.按照建议,我将模板R文件添加到包目录中名为"man-roxygen"的文件夹中.

但是,当IR CMD检查时,我得到以下注释:

在顶层找到的非标准文件/目录:'man-roxygen'

有任何解决这个问题的方法吗？

干杯,菲利普

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

R包文档系统(这是一个美丽的东西 - 谢谢你们!)给我一个带有晕影和顶部描述的索引,然后按字母顺序排列所有函数.我认为roxygen2标签喜欢@family或@describeIn会做的伎俩,但他们没有.我还注意到有些软件包的索引被初始函数字母拆分了,但是快速查看Github上的源代码并没有提出任何有用的信息.谷歌搜索和Stackexchanging不转了任何超出一些黑客就像这样,它指的是lattice.

我不敢相信我是R历史上第一个想要做到这一点的人!我通常认为听起来合理的事情在开源软件包中很容易或者至少是可能的 - 它们通常是由合理的人写的 - 但我在这里不知所措.

我在roxygen2图书馆和图书馆工作devtools。构建具有以下结构的软件包：

• 在/ data文件夹中，我有两个.rda文件，其中包含每个数据集的信息。我们称它们为data1.rda和data2.rda。

• 在/ R文件夹中，我有两个文件，一个文件具有创建的功能（及其说明），另一个文件名为data.R，其中包含每个数据集的信息。

  #' Description 1
  #'
  #' Simple definition
  #'
  #' @format The \code{data.frame} contains 2 variables:
  #' \describe{
  #'   \item{a}{The first variable.}
  #'   \item{b}{The second variable.}
  #' }
    "data1"
  

  Run Code Online (Sandbox Code Playgroud)

运行时，roxygen2::roxygenize()我收到以下消息：

第一次使用roxygen2。自动升级... get（name，envir = env）中的错误：找不到对象'data1'。

我一直在寻找类似的问题，但没有答案。有人有建议吗？

我已经roxygen2::roxygenise非常成功地使用我的包来构建导出和导入的函数.但是,我最近遇到了这个我无法解决的错误:

> roxygen2::roxygenise()
First time using roxygen2. Upgrading automatically...
Error: File file does not exist

这不是我第一次使用roxygen2这个包.另外,我不太确定"文件文件不存在"是什么意思.还有其他人看过这个并且能够解决它吗？

我目前正在为R包编写函数。此功能旨在实现的部分目的是（a）将数据作为输入，并且（b）根据可接受值的列表检查其某一列。

这些可接受的价值是从另一个组织给我的​​。它们位于.csv文件中。我想做的是加载此.csv文件，并将其用作检查来自用户的列是否具有有效值的参考。

例如，假设用户具有以下数据：

set.seed(1839)
user <- data.frame(x=sample(letters,10),
                   y=rnorm(10))
user

   x          y
1  v -0.7025836
2  p -1.4586245
3  f  0.1987113
4  y  1.0544690
5  o -0.7112214
6  m  0.2956671
7  b  0.3016737
8  a -0.0945271
9  x -0.2790357
10 c  0.1681388

.csv包含许多（有用的）列，但目前我只关心一个（z）：

ref <- data.frame(z=letters[1:4], a=rnorm(4), b=(rnorm(4)))
ref

  z          a          b
1 a -0.3563105  1.4536406
2 b  1.6841862  1.3232985
3 c  1.3073516 -0.6978598
4 d  0.4352904 -0.3971175

我想运行的代码是（注意：我没有library在实际函数中调用，为简单起见，我只是在这里做）：

library(dplyr)
valid_values <- ref %>%
  select(z) %>% 
  unname() …

因此，我尝试使用roxygen2记录我的代码。不幸的是，我的主管感到它在全球环境中具有如此众多的功能而混乱不堪。因此，有人告诉我将它们隐藏在子环境中。这似乎阻止了氧气正确地检测到它们。下面的最小示例。

my_env <- new.env()

#' test
#' 
#' more test
#' 
#' @return none
my_env$my_func <- function(){}
environment(my_env$my_func) <- my_env

我在devtools中使用Document（）命令来构建文档。但是，我一直收到错误消息“警告：min_examp.R：8：缺少名称”。鉴于我认为我不会被允许将功能放回原来的状态，然后再将它们隐藏起来，有人对如何获取氧气来检测我的功能有任何建议吗？