相关疑难解决方法(0)

如何使用Roxygen从不同的包中正确记录泛型的S3方法?

我正在编写一个包,它定义了一个新类,测量器和一个print方法,即print.surveyor.我的代码工作正常,我使用roxygen进行内联文档.但R CMD check发出警告:

在文档对象'print.surveyor'中使用但不在代码中使用的函数/方法:print

我使用了Hadley编写的以下两页作为灵感: 命名空间文档功能,两者都说正确的语法是@method function-name class

所以我的问题是:print使用Roxygen 记录我的新类的方法的正确方法是什么?更具体地说,我如何摆脱警告?


这是我的代码:(评论的文档表明试图解决这个问题,但没有一个工作.)

#' Prints surveyor object.
#' 
#' Prints surveyor object
#' 
## #' @usage print(x, ...)
## #' @aliases print print.surveyor
#' @param x surveyor object
#' @param ... ignored
#' @S3method print surveyor
print.surveyor <- function(x, ...){
    cat("Surveyor\n\n")
    print.listof(x)
}
Run Code Online (Sandbox Code Playgroud)

和氧化输出,即print.surveyor.Rd:

\name{print.surveyor}
\title{Prints surveyor object.}
\usage{print(x, ...)
#'}
\description{Prints surveyor object.}
\details{Prints surveyor object

#'} …
Run Code Online (Sandbox Code Playgroud)

r roxygen

45
推荐指数
2
解决办法
6565
查看次数

文档中的Travis CI R包错误

问候和致敬,

我最近连接了一个包含R包的github仓库给Travis CI.我认为存储库可以很好地构建,但是,有几个检查错误出现,我无法在本地安装的Windows,OS X或Ubuntu 14.04 LTS上复制.

错误源自共享以下共同的功能:

  1. 拥有使用@keyword内部编码的roxygen2帮助文档.
  2. 是使用Rcpp/RcppArmadillo编写的.

具体来说,我从Travis CI收到以下警告:

在文档对象"内部函数此处"中使用的函数或方法,但不在代码中:

这不是特别成问题,因为它是一个警告.上一篇文章使用@method和@export解决了此示例的不同形式.但是,Rcpp函数不属于OO类(S3/S4/RR).

但是,当Travis CI开始评估软件包的示例时,此警告将成为错误:

错误:找不到函数"这里的内部函数"

并导致构建失败.但是,构建本身应该通过检查,因为函数确实存在.

Travis CI 按以下方式使用建议的准则进行配置:

language: r
sudo: required
warnings_are_errors: true

r_packages:
 - ggplot2
 - devtools
 - RcppArmadillo
 - knitr
 - gridExtra
 - grid

r_build_args: "--no-build-vignettes"
r_check_args: "--no-build-vignettes --as-cran"
Run Code Online (Sandbox Code Playgroud)

注意添加了--no-build-vignettes,因为Travis在构建它们时会出错,因为R代码调用了docs中列出的内部函数之一.

我相信这是最新的面向公众的建设: Travis CI报告(v1.0.1)

CRAN第一版的结果: CRAN报告(v1.0.0)

任何想法都会受到欢迎.

r package roxygen2 travis-ci

4
推荐指数
1
解决办法
495
查看次数

标签 统计

r ×2

package ×1

roxygen ×1

roxygen2 ×1

travis-ci ×1