roxygen2

    7热度

    1回答

    我使用RStudio中的roxygen2生成软件包文档。如何强制@description部分中的以下内容显示为逐字固定字体? SettingID Value RedItem Patient_10574 GreenItem Record_433 我的解决方法是将它放到@examples \ dontrun {}中,但那不是我想要的。 @Joshua乌尔里希发现了一个(非)解决方案he

    9热度

    2回答

    Roxygen评论涉及与#'前缀行。 在编写和测试函数示例时,能够打开和关闭注释非常好。我可以将代码复制并粘贴到vim中,然后删除或添加这些注释,但这不太优雅。 是否有任何简单的方法在Rstudio中切换roxygen注释? 另外,是否有另一种方法来有效地运行由roxygen注释字符注释掉的示例R代码? 更新:横向的思考,我想使用@example examples/foo.r是避免不必使用Roxy

    1热度

    1回答

    运行roxygenize(package roxygen2)时是否可以检测是否有问题? 我想自动化进程记录,检查和构建一个软件包,并希望在记录出错时停止。 roxygenize帮助说返回值为NULL,我搜索stackoverflow没有成功。目前,我需要查看输出并搜索是否有以“Error”开头的行。 任何暗示赞赏!

    68热度

    1回答

    是否有某种机制可以用来转换roxygen所看到的评论,最好是在它进行roxygen-> rd转换之前? 例如,假设我有: #' My function. Does stuff with numbers. #' #' This takes an input `x` and does something with it. #' @param x a number. myFunction <-

    2热度

    1回答

    我正在创建一个R包,并发现将一个文件中的部分逻辑分解为内部帮助函数非常有用,这些函数在同一个文件中定义。我有一种特殊情况,我的函数通过match.fun()决定使用哪个帮助函数。由于它们不会对其他功能或人员有用,因此我不想将它们放在单独的文件中,而且我也不想导出它们。 我所有的测试案例通过使用test_dir()。当我不导出这些函数时,我的测试在R CMD检查期间失败。 "object 'help

    10热度

    1回答

    我创建一个包和S3方法我导出它们使用 ##' @method predict myclass ##' @export predict.myclass <- function(object,...) { } 现在,当我加载包,然后predict作品的类myclass的对象,但功能predict.myclass不出口。在NAMESPACE中,我只能得到条目S3method(predict,my

    10热度

    2回答

    我开发与roxygen2一个包,包括一些基于lattice可视化。这些都不错,但没有必要使用该程序包,因此lattice在DESCRIPTION文件,而不是Depends:部分的Suggests:部分列出。 但是,我还没有想出如何根据用户的要求加载lattice以便通过roxygenize()和R CMD check。以下两种方式都使得lattice看起来像一个未声明的依赖项,并将返回下面的错误。

    8热度

    2回答

    将roxygen2文档与devtools一起使用document函数会自动在软件包描述中生成一个Collate:字段,而不管是否需要按特定顺序加载软件包库文件。 我正在使用一堆S4方法打包,希望确保类定义在使用它们之前加载任何方法或其他类,我知道我可以使用Collate列表,我不知道如何用roxygen2文档格式表明这一点。 roxygen2 manual对@include标记作了一些参考,但看起

    10热度

    2回答

    我使用devtools来构建R程序包,并且有一些功能不能被终端用户看到。但是,由于这些功能涉及通过.Call调用C代码,因此我必须将@useDynLib编写在用于自动生成.Rd文件的函数之上。这样,当我构建软件包时,即使我没有包含这些函数的@export,它们仍然出现在帮助文档中...有没有办法通过抑制这些函数,即使它们已被记录在案?谢谢!

    8热度

    1回答

    每当我从RStudio的Build窗格中运行Build & Reload,我得到的消息 ==> Rcmd.exe INSTALL --no-multiarch rwiots Error: contains a blank line ,事实上,当我看,我的描述文件在Suggests字段中包含空行。如果我删除它,当我尝试Build & Reload时,它会再次创建。 我有选项Generate