如何解决添加示例时,pkgdown 无法解析 Rd 文件
出于某种原因,pkgdown
无法解析我的包中的 .Rd 文件之一。我发现当我使用 roxygen2
标记或 @examples
替代方法向 @example inst/example/add.R
文档添加示例时,它失败了。我将我的函数最小化为两个参数,以使其更“可重现”并且仍然得到相同的错误。请在错误消息下方找到使用该 devtools::document()
生成的 .Rd 文件以及函数的 roxygen2 文档。如您所见,我正在使用一个非常简单的示例,该示例应该可以正常运行...还有一点要说的是,当我运行 devtools::check()
时,我所有的示例都通过了,所以我不明白为什么 {{1 }} 失败了。
非常感谢您的帮助。
最好,
错误信息
pkgdown
.Rd 文件
Reading 'man/merge.Rd'
Error : Failed to parse Rd in merge.Rd
i unused argument (output_handler = evaluate::new_output_handler(value = pkgdown_print))
Error: callr subprocess failed: Failed to parse Rd in merge.Rd
i unused argument (output_handler = evaluate::new_output_handler(value = pkgdown_print))
roxygen2 文档
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/merge.R
\name{merge}
\alias{merge}
\title{Merge two tables}
\usage{
merge(x,y)
}
\arguments{
\item{x}{data frame: referred to \emph{left} in R terminology,or \emph{master} in
Stata terminology.}
\item{y}{data frame: referred to \emph{right} in R terminology,or \emph{using} in
Stata terminology.}
}
\value{
a data.table joining x and y.
}
\description{
This is the main and,basically,the only function in joyn.
}
\examples{
x <- c(1,2)
}
解决方法
这个错误来自downlit::evaluate_and_highlight
(遗憾的是它没有在输出中报告),可以通过安装downlit
的开发版本来修复:
library(devtools)
install_github('r-lib/downlit')
仅当您使用同样来自 pkgdown
的 git 版本时才有意义,稳定版 pkgdown
(版本 1.6.1)与稳定版 downlit
一起运行得很好。当然,任何包的开发版本都可能随时崩溃,但直到它不崩溃为止。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。