问题标签 [vignette]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
1042 浏览

r - 在构建和重新加载 R 包时显示小插图链接

我通过运行代码为我正在开发的 R 包创建了一个vigenttedevtools::use_vignette("my-vignette")文件夹。我正在使用Rmarkdownknitr包。

当我构建和重新加载包时,我没有在包的文档页面中获得 Rmarkdown 文件(包含包的长格式文档)标题的超链接。我确实获得了包的说明文件的超链接以及文档化功能的帮助页面,但没有将人们引导至 Rmarkdown 文档的超链接。我想知道为什么以及我应该怎么做才能以类似于我为包中使用的函数的帮助页面获取它的方式获取包的长格式文档的 hperlink?

0 投票
2 回答
464 浏览

r - 加载“库(包名)”时提醒用户注意包小插曲的最佳实践?

我正在编写一个 R 包,并在文档小插曲上花费了大量时间。我想知道我是否应该添加类似的东西

当用户调用时会立即显示

告知用户有关包小插曲的最佳方式是什么?还是只是假设用户会在没有明确通知的情况下寻找它们?

0 投票
0 回答
63 浏览

r - 构建一系列 R 小插曲的最有效技术,每个示例数据集都有一个?

我们正在建立一个r package来评估调查数据中的收入不平等https://github.com/DjalmaPessoa/convey

我在这里有大约十个不同的公共使用微数据集 - https://github.com/ajdamico/asdfree - 我想提供使用示例以及特定于数据集的小插曲。在大多数情况下,小插图将完全相同,我只想要一个可用于不同调查的不同小插图。我只希望整个小插图中的一些内容有所不同,例如: title/vignette名称、调查加载脚本、调查设计对象名称、数据集中的收入变量

我们正在编写的包有大约十几个不同的功能,我想以一种(看似为用户)特定于数据集的方式在十个不同的公共使用文件中演示它们——但我不想写十个几乎相同的小插曲

有没有一种合理的方法来编写一个文档,然后自动生成特定的小插图?我正在考虑诸如 Microsoft 邮件合并之类的东西,但我不确定这里会有什么等价物。谢谢!

0 投票
0 回答
728 浏览

r - “R CMD build”失败并出现“texi2dvi 错误”

自 2009 年以来一直在 CRAN 上的“sos”包我遇到了新问题。一个问题是“R CMD build sos”失败如下:

该软件包可在 R-Forge 上获得。日志文件(build_src) 也在那里可用 这是来自 R-Forge 上的 R 3.3.1 的消息。我在运行 10.11.5 的 Mac OS X 上收到了类似但略有不同的消息形式 R 3.3.0。

此构建日志表明问题出在“sos”小插图上。但是,如果小插图有问题,我希望在 RStudio 0.99.902 中单击“编译 PDF”时看到它。相反,它声称运行完成,生成“sos.pdf”。(该输出还有其他问题,但这是另一篇文章的主题。)

谢谢,

0 投票
0 回答
48 浏览

r - RStudio 中 Sweave 小插图的“编译 PDF”丢失了参考

RStudio 0.99.902 和 R 3.3.0 中的“编译 PDF”找不到包含在“sos”Sweave 小插图中的引用,该小插图自 2009 年以来一直是 CRAN “sos”包的一部分。它生成“sos.pdf”,主要阅读好的,除了内联引用被替换为“?”之类的东西。

例如,一个条目“\citet[pp. 282-283]{JC09}”之前翻译为“Chambers (2009, pp. 282-283)”,现在显示为“?, pp. 282-283”。“\bibitem[Chambers(2009)]{JC09}” 条目仍位于文件末尾并与参考书目一起打印,但 RStudio 中的“编译 PDF”无法找到它正确替换“\citet[pp. 282-283]{JC09}”。

关于如何解决这个问题的任何建议?
谢谢,

0 投票
1 回答
594 浏览

r - 在 R markdown 包小插图中包含错误

我正在开发一个 R 包并有一个包含if(condition) stop("Error message")条件的自定义函数。我在包小插图中调用此函数,目的是生成错误消息并将其包含在小插图中。但是,这导致小插图构建失败。

即使代码生成错误消息,如何强制进行小插图构建,并将这些错误消息保留在小插图文档中?

0 投票
0 回答
756 浏览

r - 为什么我的 rmarkdown 文档中不显示图形标题?

我正在使用rmarkdownknitr

我有两个问题:

Q1:我不确定为什么我构建rmarkdown文档时没有出现图形标题。

这是一个例子。我在那里得到了这个数字,但没有数字标题!

Q2:我正在使用 RStudio 开发一个 R 包。我可以html_vignette使用下面的代码创建一个。但是,我不确定为什么当我将输出更改为时无法创建 PDF 小插图output: rmarkdown::pdf_vignette?后者给出一个错误:

Error: 'pdf_vignette' is not an exported object from 'namespace:rmarkdown' Execution halted

我是这个领域的新手,所以如果有人能解释一下,那就太好了。

0 投票
1 回答
1590 浏览

r - 包有一个 VignetteBuilder 字段,但没有预建的小插图索引

我正在向 CRAN 提交一个包,我收到了来自审阅团队的以下警告:

包有一个 VignetteBuilder 字段,但没有预建的小插图索引。

事实上,我在跑步时也看到了devtools::release()。我正在使用最后一个R版本,R version 3.3.1并具有以下.Rmd小插图源:

此外,我已默认包含knitr在文件中:DESCRIPTION

我环顾四周,虽然这个问题似乎很常见,但我无法理解为什么索引没有构建(以及如何强制构建它)。


这个问题和其中的链接是谷歌搜索结果,但不能解决问题。

0 投票
1 回答
1117 浏览

r - R 包警告:“vignettes”目录中的文件比“inst/doc”中的所有文件都新

在 R 包中,我有两个旧版 Sweave 小插图作为.Rnw文件。当我在本地检查包时(在 R Studio 中:Build -> Check),没有错误或警告,当我使用 R 版本 3.3.1 Patched (2016-10) 在 R-Forge 上检查我的包时,情况也是如此-17 r71531)。

但是,当我将包提交给 Win-builder (via devtools::build_win()) 以在 R devel (unstable) (2016-10-16 r71524) 下检查时,我收到以下无法解决的警告:

我的包目录结构包括 in 的小插曲和 in的vignettes/结果,如下所示:devtools::build_vignettes()inst/doc/

我将生成的.pdf文件包含在其中的原因inst/doc/是,否则我会收到警告说.pdf文件需要使用 压缩qpdf,而我实际上可以这样做的唯一方法是在 Acrobat Pro 中打开它们并重新保存为压缩 PDF。

我尝试添加inst/docto .Rbuildignore,但这会产生错误。我也尝试添加inst/doc/*.pdf.Rbuildignore但没有效果。

该警告阻止我向 CRAN 提交更新。我不明白为什么更新的文件vignettes/应该是一个问题,但我该如何解决这个警告?

0 投票
1 回答
2050 浏览

r - devtools::check 由于小插图构建而失败

我正在开发一个包,并考虑在其中包含一个小插图。我使用 RStudio 进行包开发,并按照Hadley Wickam的说明使用Rmarkdownknitr/或编写小插图。

从 Rstudio按下时,我可以编译小插图,knit但命令devtools::check()返回错误:

我应该怎么做或改变?我知道这只是支票。

会话信息: