问题标签 [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 回答
146 浏览

r - knitr的剩菜

我正在knitr为我的包裹写一个小插图。在R CMD CHECK我得到以下注意事项:

这些确实是由knitr. 但我不明白如何在将文档编织成 .pdf 后删除这些内容。

我在github上发现了一个相关问题,但没有答案。

0 投票
0 回答
328 浏览

r - knitr 不构建小插图

我正在用Rmarkdown. 我尝试遵循 Hadley、Yihui、Rstudio 备忘单的所有教程……但我仍然无法正确嵌入小插图。

现在我有一个.Rmd文件,通过按下 Rstudio 按钮“knit”可以很好地编译。然而:

  • devtools::build_vignettes()返回NULL
  • 构建源包并运行对文件夹R CMD INSTALL没有任何作用/vignettes
  • 我已经检查了use roxygen for vignetteRstudio 参数中的框
  • 当我使用 Rstudio 编译时,它将 .pdf 输出保存在有线临时目录中:

创建的输出:/private/var/folders/53/l9bfpvgj4y7brgnjwym34kph0000gn/T/RtmpydyKqk/preview-ffc141c28b47.dir/mistral-vignette.pdf

由于我的小插图的构建时间很长,我很乐意仅包含 .pdf 输出


YAML 输入:

在DESCRIPTION文件中,我添加了:

0 投票
1 回答
832 浏览

r - 从 R 包中的手册链接到小插图的最佳方法

我正在开发一个 R 包,我正在尝试从包的手册链接到它的小插图(pdf)。我在 R 函数代码中做了这个,它可以工作:

问题是 devtools::check() 抱怨警告,这也导致上传到 CRAN 时的修订过程延迟......

有没有更好的方法来连接从人到小插图?或者这样做是不正确的?由于 pdf 可以包含更多图形信息,因此能够链接到它似乎是可取的。

0 投票
0 回答
81 浏览

r - 当在小插图中包含静态 PDF 文件时,如何解决“R CMD 检查”中的注意事项?

我希望在我的 R 包的小插图中包含一个静态 PDF 文件biglasso。我按照此处此处的说明进行操作。但是,当我运行时R CMD check,总是有一条 NOTE 说:

是完整的包裹检查信息。

谁能向我解释这个注释的含义以及如何解决它?

0 投票
2 回答
1202 浏览

r - 错误:处理小插图失败,诊断失败:同时产生 4 个进程

我正在为 R 包 mistra 构建一个小插图(请参阅 github.com/clemlaflemme/mistral)并devtools::check(cleanup = FALSE)返回警告

我在 Google 上找不到任何帮助。实际上我确实在小插图中使用了并行计算,这是不允许的吗?

0 投票
1 回答
337 浏览

r - 如何在小插图中的同一个 R 包中放置指向另一个小插图的链接

我有一个关于 Bioconductor 的包,我正在为其添加第二个小插曲。

我想将第二个小插图链接到第一个小插图,因为一个小插图用于包的一般工作流程,第二个小插图用于精细参数调整,适用于更高级的用户。

有干净的方法吗?

我发现的唯一相关主题是: best way to link to a vignette from manual in an R package

但它并没有真正帮助我,

谢谢你的帮助,亚历克西斯

0 投票
1 回答
323 浏览

r - CRAN 不会检查的小插图

我正在制作一个带有 knitr/rmarkdown 小插图的 DB 客户端包,它演示了一些基本的用例。

我希望它出现在包的 CRAN 版本中,但显然它不会在那里构建,因为缺少数据库服务器。

处理这个问题的规范方法是什么?

0 投票
1 回答
1055 浏览

r - R:跳过在 CRAN R CMD 检查上运行的小插图

我在一个R包中有许多运行缓慢的小插曲。据我了解,CRANR CMD check不会重建小插图,但会运行其相应的代码。

由于小插曲运行缓慢,我认为不遵守 CRAN 政策。但是小插图是有用的例子,有数字。所以我想知道是否可以只为 CRAN 跳过运行的小插图代码R CMD check,有点像你可以跳过单元测试使用testthat::skip_on_cran()?

0 投票
1 回答
98 浏览

r - 生成然后嵌入外部文件的小插曲:或者,小插曲中 html 小部件的最佳实践

我刚刚向 CRAN 提交了drake 4.0.0,但小插曲没有正确显示。为了包含visNetwork 小部件,我使用代码块编写外部 HTML 文件,然后使用 iframe 标签将 HTML 嵌入回小插图中。(带有 HTML 小部件的自包含小插图需要 pandoc,这会使 Mac 和 Solaris CRAN 检查喷出警告。)我在任何应该有交互式图表的地方都看到 404 错误。我曾尝试使用R Extensions Manualvignettes/.install_extras中的文件,但没有成功。

编辑 因此,如果我想在小插图中嵌入一个中等大小的 HTML 小部件,似乎所有当前选项都违反了 CRAN 准则:

  1. 以自然的方式将小部件嵌入到小插图中。不幸的是,这种方法需要 pandoc 并扩大了小插图的文件大小,这两者都会在 CRAN 检查中生成警告和注释
  2. 将小部件生成为外部 HTML 文件的集合,并将根文件作为 iframe 嵌入。

    一个。如果这些 html 文件没有以 结尾inst/doc,则根本不会显示小部件。

    湾。如果它们最终进入inst/doc,那么这些文件将非常大,以至于它们会在 CRAN 检查中生成注释

我错过了什么吗?我确实计划在下一个德雷克补丁中放弃小插曲中的交互性,但我对此感到失望。

0 投票
1 回答
646 浏览

r - 使用 `devtools::build_vignette` 编译一个小插图,以便 .md 保存在小插图目录中

我正在尝试编译一个包小插图,以便 .md 文件保留在小插图文件夹中,以便它在 github 上仍然可见。我正在使用devtools所有这些。我已经研究过这种方法,并将在下面概述:

我已经自动生成了一个小插图模板 use devtools::use_vignette()。然后我将.Rmd文件修改为如下所示(截断模板版本):

所以.yaml修改了但是当我使用它编译时devtools::build_vignettes()似乎没有.md在小插图目录中留下文件。没有错误消息,并且小插图构建良好,所以这有点令人困惑。

所以总结一下这个问题,有谁知道如何编译一个小插图devtools::build_vignette,以便将基本的降价文件保存在小插图目录中?