在参考部分中使用Roxygen2模板标签

时间:2017-11-24 14:43:51

标签: r templates r-package

我对Using Roxygen2 Template tags的基础知识很有信心,它在替换@param的调用时工作正常,但在使用模板添加对引用部分的引用时遇到问题。

man-roxygen/refEstabrook1985.R的模板读取

#' \cite{Estabrook G.F., McMorris F.R., Meacham C.A. 1985. Comparison of undirected phylogenetic trees based on subtrees of four evolutionary units. Syst. Zool. 34:193--200.}

我尝试了几种方法将其链接到参考块。

没有大括号

#' @references
#' @template refEstabrook1985

给出警告Warning: @references [QuartetDistance.R#218]: requires a value,但不呈现引用部分。

大括号,没有空格

#' @references {
#' @template refEstabrook1985
#' }

发出警告  Warning: @references [QuartetDistance.R#218]: mismatched braces or quotes Warning: @template [QuartetDistance.R#219]: mismatched braces or quotes并且不会在.Rd文件中呈现引用部分。

大括号和空格

#' @references {
#'  @template refEstabrook1985
#' }

(注意附加空格)没有提供警告,但不扩展模板,因此手册页显示“参考文献:@template refEstabrook1985”

1 个答案:

答案 0 :(得分:0)

我想我已经确定我想做的事情是不可能的。 Roxygen manual表示

  

模板必须由完整标签组成 - 因为所有roxygen标签都是当前块标签,所以它们不能用于内联插入。

另一种方法是使用Rdpack:见Citing articles using roxygen2