R 包文档中的 HTML 验证问题

Question

我正在向 CRAN 提交 R 包，但在运行时遇到以下注意事项

devtools::check(remote = TRUE, manual = TRUE)

:

checking HTML version of manual ... NOTE
  Found the following HTML validation problems:
  plot_interactive.html:15:44 (plot_interactive.Rd:5): Error: <main> is not recognized!
  plot_interactive.html:15:44 (plot_interactive.Rd:5): Warning: discarding unexpected <main>
  plot_interactive.html:74:1 (plot_interactive.Rd:37): Warning: discarding unexpected </main>
  plot_interactive.html:4:1 (plot_interactive.Rd:5): Warning: <link> inserting "type" attribute
  plot_interactive.html:12:1 (plot_interactive.Rd:5): Warning: <script> proprietary attribute "onload"
  plot_interactive.html:12:1 (plot_interactive.Rd:5): Warning: <script> inserting "type" attribute
  plot_interactive.html:17:1 (plot_interactive.Rd:5): Warning: <table> lacks "summary" attribute
  plot_interactive.html:38:1 (plot_interactive.Rd:10): Warning: <table> lacks "summary" attribute
  start_gui.html:15:44 (start_gui.Rd:5): Error: <main> is not recognized!
  start_gui.html:15:44 (start_gui.Rd:5): Warning: discarding unexpected <main>
  start_gui.html:75:1 (start_gui.Rd:37): Warning: discarding unexpected </main>
  start_gui.html:4:1 (start_gui.Rd:5): Warning: <link> inserting "type" attribute
  start_gui.html:12:1 (start_gui.Rd:5): Warning: <script> proprietary attribute "onload"
  start_gui.html:12:1 (start_gui.Rd:5): Warning: <script> inserting "type" attribute
  start_gui.html:17:1 (start_gui.Rd:5): Warning: <table> lacks "summary" attribute
  start_gui.html:35:1 (start_gui.Rd:10): Warning: <table> lacks "summary" attribute

我正在使用

roxygen2

生成

.Rd

文件。此注释似乎通常是由旧版本的

roxygen2

引起的（请参阅此 GitHub 存储库）。但是，我已经在使用

roxygen2

版本

7.2.X

，并已更新为

roxygen2_7.3.2

，以及最新的 R 版本（4.4.1）并重新运行

devtools::document()

。不幸的是，问题仍然存在。

有问题的包裹可以在这里找到。包含

roxygen2

注释的 R 文件是：

• start_gui.R

• plot_interactive.R

生成的

.Rd

文件是：

• start_gui.Rd

• plot_interactive.Rd

任何关于解决这些 HTML 验证问题的见解将不胜感激。

Answer 1

我以前从未见过

@examplesIf

和

\dontshow

。我用谷歌搜索了一下，这里有一些观察结果。

示例的 R 代码是您的 Rd 文件中的以下代码：

\dontshow{

if (interactive()) (if (getRversion() >= "3.4") withAutoprint else force) (\{ 

library(lavaan)
model <- ' 
  visual  =~ x1 + loadingx2*x2 + x3
  textual =~ x4 + x5 + x6
  speed   =~ x7 + x8 + x9
'
fit <- cfa(model, data = HolzingerSwineford1939)
plot_interactive(fit)

\dontshow{\})
}

我可以在这个旧线程以及官方编写R扩展中看到，使用

\dontshow

，示例代码不会向用户显示，但此代码在R检查期间执行 .

所以，

@examplesIf

不是你想要的。