在试图为this question寻找解决方案时,我发现自己试图编写有效的Rd标记。我想要的是添加一个名为Raw Function Code的部分,并将该函数的代码放在它下面。我已经写一个脚本来修改Rd文件实现在这方面有限的成功,包括 \section{Raw Function Code}{\code{
# some piece of R script will eventally provid
我写了一个小包供我自己使用,并且使用devtools一切都很顺利。但是,我试图运行R CMD Check,并且出现了一些错误,这似乎是因为我的用法和示例使用了基本R中不在我包中的函数,例如这里是我的最小函数,以及roxygen文档 #' Function to Sort a dataframe with a given list of columns
#' Cribbed from Specto
这比烦恼更麻烦,但是有什么办法可以防止在编译R中的文档和一行太长时发生的行“溢出”? 与R CMD Rd2pdf [options] files创造了一些文件的一个片段: 我找不到任何地方这样的记载,以及Rd2pdf唯一的选项是: Options:
-h, --help print short help message and exit
-v, --version prin
可能重复: How to properly document S4 class slots using Roxygen2 我想建立,使用R Studio和roxygen2包含S4 classes包。 当我将几个S4 classes引入到我的包中时,我已经使用roxygen2语法记录了我的所有函数。 现在我意识到,没有'@ slot'功能的开箱即用。所以我想知道如何让我的所有文档都能用于其他功能,并
可能重复: Escaping “@” in Roxygen2 Style Documentation 我怎么能roxygen文档中使用@如: #' @param arg An argument that uses the symbol @
这将抛出了一个当您运行roxygenize时未发出警告,并且未将@放在.Rd文件中。
我有一个通用的打印功能,我认为我已经正确地设置了基于通用功能(LINK,无可否认有点难以掌握)和这个问题(LINK)。但是,它仍然在检查中发出警告。下面是一个模拟功能,打印方法,roxygen文档和检查错误。有关打印功能的背景知识;基本上我希望输出看起来不像是类,但它仍然带有一个用于通过后续函数处理该对象的类。如何使警告消失(并保持打印功能)? FUN <- function(x) {
举一个简单的,具体的例子: #' Inverse Value Matching
#'
#' Complement of \code{%in%}. Returns the elements of \code{x} that are
#' not in \code{y}.
#' @usage x %nin% y
#' @param x a vector
#' @param y a vect