【问题标题】:Manual PDF no longer created with package check?不再使用包检查创建手动 PDF?
【发布时间】:2016-07-29 14:18:46
【问题描述】:

我使用 RStudio (0.99.891) 中的构建环境进行所有包开发。从历史上看,当我运行包检查时,生成的package.Rcheck 目录将有一个package-manual.pdf 文件,但在过去几个月中,每当我检查包时,手动 PDF 不再出现在我的目录中。我没有更改任何检查包选项,但继续使用--as-cran

似乎 RStudio 尚未在线更新他们的 how to customize build options 文档,所以这无济于事。在 SO:After running R CMD Check, the mypackage.Rcheck directory with PDF manual disappeared 上看到这个问题后,我仔细检查了“R CMD Check 成功后的清理输出”未选中。

在 RStudio 过时的文档中,他们描述了一个 --no-manual 选项,但也许现在这是默认选项?

如何取回手册?我喜欢在提交给 CRAN 之前检查一下,以确保没有问题。

【问题讨论】:

  • 我同意为什么不是编程而是如何取回 PDF 我认为是非常合适的。
  • 我删除了关于他们为什么这样做的思考,现在更明确地询问如何取回它。
  • 我没有听说过任何关于使用该确切术语作为 CRAN 要求的“手册”。您确定您不是在考虑帮助页面索引或小插图吗?
  • 如果您在 CRAN 上查看任何包的页面,您将看到指向“参考手册”的链接。这个 pdf 曾经是在您检查内容时创建的,但它不再是
  • --no-manual 文本实际上并不是 RStudio 的一部分,而是当您在系统命令行中运行 R CMD check --help 时的输出。在 3.2.0 版本中,您是否可能受到此 NEWS 项目的影响? “现在构建手册需要 texinfo 5.1 或更高版本的 texi2any。CRAN 二进制构建包含手册,但默认情况下不会从源代码构建,它们将从 CRAN 访问。请参阅 'src/gnuwin32/MkRules.dist' 中的 cmets如何指定 texi2any 的位置。”

标签: r documentation rstudio documentation-generation


【解决方案1】:

--no-manual 文本实际上并不是 RStudio 的一部分,而是当您在系统命令行中运行 R CMD check --help 时的输出。在 3.2.0 版本中,您是否可能受到此 NEWS 项目的影响?

"现在构建手册需要 texinfo 5.1 或更高版本的 texi2any。CRAN 二进制构建包含手册,但默认情况下从源代码构建不会,它们将从 CRAN 访问。请参阅 'src/gnuwin32/MkRules 中的 cmets .dist' 了解如何指定 texi2any 的位置。”

【讨论】:

  • 对于 R 的 Mac OSX tarball,cmets 是:for texinfo >= 5.1。如果 texinfo 文件安装在 /packages/texinfo,TEXI2ANY = /path/to/perl -I/packages/texinfo /packages/texinfo/texi2any 如果你没有 texinfo(默认),TEXI2ANY = missing
【解决方案2】:

这不是问题的解决方案,而是替代方案。安装和配置 texi2any 本地化有点棘手,所以我直接从 windows shell 编写手册解决了它,如下所示:

R CMD Rd2pdf file_location

file_location 是包含包中所有文件的文件夹的路径,如DESCRIPTION、man 文件夹等。

【讨论】:

  • 请注意,在此之前您需要安装 pdfLateX(例如,从这里miktex.org/howto/install-miktex)并允许 R 从 Windows shell 运行:控制面板 > 安全和系统 > 系统> 高级系统配置 >环境变量。点击路径并编辑:将路径添加到R(例如,C:\Program Files\R\R-3.0.2\bin\x64)
猜你喜欢
  • 2016-11-26
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2013-06-03
  • 2019-06-19
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多