问题标签 [vignette]

我是编写 R 包的新手。我正在尝试学习如何为我的包裹制作小插图。我创建了一个带有文件“getting-started.Rmd”的小插图文件夹

要构建小插图，我使用以下命令：

然后我运行Rcmd.exe INSTALL my_package，并查看我运行的小插图：

但是我只看到 html 和源格式的小插曲：

正如您在屏幕截图中看到的，没有“pdf”选项。如何配置我的 .Rmd 文件以创建 pdf 格式的小插图？

我试图把一个包裹的松散端绑起来，我几乎只剩下小插曲了。我在包装中有四个小插曲。对于参考，我们将它们称为 Vignettes A - D。当我运行时R CMD check，我得到了错误

但是，每当我使用 R Studio 中的 knit 按钮处理 Vignette A 时，文档编译得很好。

所以我开始玩，最终，我发现R CMD check无论何时我在包装中都有 Vignettes A 和 C 都失败了。但是任何时候我删除这两个小插曲中的任何一个，都R CMD check没有错误地通过。

我不知道从哪里开始。关于这两个文件共存于一个包中可能存在什么问题的任何想法？

我正在使用 R 3.2.0。有问题的包位于 Github的开发分支中

.Rcheck 日志文件的输出

我正在将 https://github.com/stan-dev/example-models/tree/master/bugs_examples中的 BUGS 示例转换为仅示例包，每个示例都有一个 .Rmd 小插图。完整的软件包将基于 TravisCI 构建。

为一个示例构建一个小插图至少需要 2 分钟，因此对于调试构建，应该可以包含/排除单个小插图。我知道我可以手动运行单独的 Knit 运行，但有时需要运行整个构建。

在我当前的解决方法中，Rmd 文件被移动到另一个目录，但解决方案并不好。我正在寻找这样的东西：

欢迎其他想法。

我正在整理一个 R 包。我想在小插图中显示示例代码，其中示例数据文件（包含在包中）用于生成（示例）输出文件。

我在 Hadley Wickham 的帖子 ( http://r-pkgs.had.co.nz/data.html ) 中阅读了有关使用示例数据的信息，并相信我应该将示例数据保留为原始数据，因为必须对其进行解析才能生成输出。

所以，我在我的包结构中创建了一个目录

带有子目录 InputFiles 和 OutputFiles。

我将示例文件 (exampleData.csv) 放在 InputFiles 子目录 (/Users/userName/myPackage/inst/extdata/InputFiles) 中。

我的小插图位于：

它包含以下语法：

我在开发这个小插图及其示例数据集时遇到了两个问题：

1) 我不确定我对 extdata 文件的使用是否合适。根据前面提到的 Hadley Wickham 参考资料，这似乎是放置我的示例文件的最佳目录名称和位置。

2）我不确定如何使路径相对而不是绝对，就像我目前拥有的那样。如您所见，此示例代码不会自动运行。相反，我将它放在 eval=FALSE 的 R 块下，以便将其简单地列在那里供用户测试自己。运行示例代码后，用户还可以检查输出文件确实是在 (/Users/userName/myPackage/inst/extdata/OutputFiles) 中创建的。在遵循示例时，让用户不必使用绝对路径的最佳方法是什么？是否可以只从包目录 myPackage 中遵循相对路径？

我的数据文件由 .csv、.htm 和 .text 文件组成。过去，在构建包时，我将数据框保存为 .rda 文件，然后用户可以简单地使用：

读取该文件。他们不必编写整个路径。是否有类似的功能可用于读取 .csv、.html 和 .text 文件，然后将它们输出到示例输出位置 - 而无需使用完整路径？是否有可能拥有同时读取输入文件并写入输出文件的帮助功能？如果 /man 文件夹中的各种示例帮助功能将示例输出文件物理保存到示例输出文件夹，这会导致 CRAN 中的冲突吗？

我正在为打算提交给 CRAN 的包裹写一个小插图。我遇到的一个问题是，某些函数及其输入参数可能会变得很长，以至于它们的示例代码会超出页面。

我担心这是 LaTeX 的一个细致问题，因为我之前已经发生过很多次了。但是，我希望所有示例代码对用户可见。幸运的是，我放在小插图中的示例代码都不应该自动运行。因此，我在 R 块中有一个 eval=FALSE 表达式。

作为故障排除解决方案的（可能的黑客？），我刚刚在代码中手动插入了一个无论如何都不会运行的换行符。这允许示例代码不会在页面外运行，并且不会影响无论如何不会自动运行的示例代码的功能。

这个“解决方案”是否符合 CRAN 标准？如果不是，我可以尝试考虑什么其他解决方案来解决这个问题？

下面是我的 MWE：

我正在构建一个新的 R 包。我在 这里给出了同样的问题。我也浏览了建议的链接。但我不断收到拒绝，因为纸条上写着

“包有一个 VignetteBuilder 字段，但没有预建的小插图索引。
所以请添加一个小插图索引。”

我去了 CRAN 包列表以获取 最新的包，然后浏览了 hyfo、 mldr 和其他一些在过去几天都发布的包的代码。他们都没有索引文件。但是，我下面的代码被拒绝了。我的代码在运行时没有显示任何警告、错误或注释devtoold::check()。我也没有收到任何警告/错误devtools:build_win()。
关于我所缺少的任何想法？

我在 Windows 上使用 R 版本 3.2.2。我的DESCRIPTION文件具有以下内容

在vignettes目录中，该文件Mypackage.Rmd 有

如何创建小插图索引或如何使此注释消失？

我一直在阅读 R 的 Affy 手册，它指的是其他小插曲。这两个术语之间的区别只是与内容的数量有关，还是有更多？

我正在尝试在我的 R 包 MDP2 https://github.com/relund/mdp中构建一些小插曲。如果我从 RStudio 运行devtools::build_vignettes()一切都可以正常编译。但是，如果我使用devtools::build()或者devtools::install_github("relund/mdp", build_vignettes = TRUE)我收到以下错误。任何想法为什么？

我一直在参考Hadley 的指南写一个个人包。但是，添加一个最小的小插图 usingdevtools::use_vignette()似乎会破坏devtools::check().

当我尝试运行时，check()出现一个错误：

和一个警告：

devtools::check()如果我删除了 vignettes 文件夹并devtools::build_vignettes()运行正常，我可以成功运行。

编辑添加： 我想知道这是否是从网络位置尝试运行检查的问题，但我将项目复制到C:\R\package_name它仍然返回相同的错误。

奇怪的是，这似乎与机器有关，因为我在工作机器上收到上述错误，但在我的个人笔记本电脑上却没有。工作机是win7，个人win10。

描述复制如下

我有一个"Vignette Collab"在带有 Java 的 Apache 堆栈上运行的 API，我继承了一个遗留代码库，需要找到这个错误的来源，显然最后一个开发人员构建了一个不起作用的功能，这就是错误所在，但没有更多信息。它使用 Drupal webservice 模块，发送调用的代码如下所示

关于我可以从哪里开始查找此错误或它可能意味着什么的任何想法？

完整的堆栈跟踪在这里:::

用户失败：null。java.lang.UnsupportedOperationException：com.acuitys.ws.impl.CollabServiceImpl.populateProperties(CollabServiceImpl.java:236) 的 com.intraspect.kmapi.client.KMDocument.getDocType(KMDocument.java:331) 的客户端尚不支持此方法) at com.acuitys.ws.impl.CollabServiceImpl.getChildren(CollabServiceImpl.java:83) at com.acuitys.ws.CollabWebservice.getChildren(CollabWebservice.java:34) at sun.reflect.GeneratedMethodAccessor758.invoke(Unknown Source) at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) at java.lang.reflect.Method.invoke(Method.java:606) at com.sun.xml.ws.api.server.InstanceResolver$1。51 AM (http-bio-81-exec-3_532)]：用户身份验证失败：null。[2016 年 4 月 22 日上午 10:59:51 (http-bio-81-exec-3_532)]：ecmtrtest1：http cmd：查找，http-bio-81-exec-3，kmapi=true&properties=true&dtd=false&oid=1.9 .2878889 [2016 年 4 月 22 日上午 10:59:51 (http-bio-81-exec-3_532)]：用户身份验证失败：null。