问题标签 [vignette]

我R在 GitHub 上有一个要提交给 CRAN 的包。到目前为止，该软件包有一个广泛的 README.md 文档，其中显示：

• 包核心功能执行的例子，
• 包演示执行示例，
• 一些基准测试结果。

出于 GitHub users 的目的，我认为将这些放到 README.md 中比 vignette 更有吸引力，因为它会在用户查看包的 repo 时出现。

当我将包移动到 CRAN时，我希望以小插图的形式提供与 README.md 中当前几乎相同的内容。

问题：将几乎 1-1 的 README.md 副本制作成一个小插图，保留两者，更新 GitHub 存储库以拥有这个小插图，然后提交给 CRAN，这是一种正确的行为方式吗？或者：它会造成不应该发生的重复？（那我应该怎么做？）

我有一张彗星的照片。我正在尝试使用 GIMP 来改进它，但它对我来说就像航天飞机。

你能描述一下步骤吗

1. 消除或减少图像角落的渐晕
2. 消除或减少天空辉光并使天空更暗，同时保持恒星和彗星的亮度大致相同（提高对比度？）
3. 减少数字噪声（也许某种形式的高斯模糊不会影响恒星和彗星的清晰度？）

谢谢！

彗星 46P/Wirtanen

我为我的包裹创建了一个 R 小插图。这个小插图嵌入了一个带有 webGL 的交互式 rgl 图形。

它工作得很好，但对我的需要来说太过分了。一张简单的非交互式图片就足够了。webGL 显示的问题在于它会创建一个大文件 (>1 Mb)。因此，我在 CRAN 上有一个关于目录大小的注释。而不是争论这个注意我想使用常规图片来减小 html 输出的大小。

这显然是行不通的。

当我在 RStudio 1.1.463 中使用 usethis 函数 1.4.0.9000 和 devtools 2.0.1 时，我正在尝试添加一个包的小插图并让它显示在它的文档中。我用 usethis 制作了一个新包并设置了许可证，然后添加了一个通用的小插图：

我轻轻地调整了小插图，让它编织起来。我注释掉库调用并在小插图的最后一行空白处添加一些文本：

然后使用 Knit 按钮检查它是否有效，它会编织并显示 HTML 页面。

我使用构建选项卡更多菜单并选择文档，它说：

没有提到小插曲。所以我认为这仅适用于 man 文件夹...

然后我使用 Build 菜单 Install and Restart 按钮，然后打开包文档（在包窗口窗格中）它没有说明任何关于小插图的内容。

所以我尝试使用：

它给了我有意义的反馈：

但是当我再次安装并重新启动时，文档没有提到小插图。

那么，如何在其包文档中显示一个小插图作为链接？

我有点困惑，为什么 R 包中有多个可能的“小插曲”位置。我不明白哪些位置用于什么以及何时。例如：

在包的根目录下创建一个 vignettes 文件夹

创建一个 inst/doc 文件夹，该文件夹在构建时提升到根目录

创建一个 docs 文件夹。

作为背景：我已经阅读了 H.Wickhams R 包的书，并且我使用第一个选项创建了几个包，所有的东西都表现得很好。我会让用户从 github 安装：

现在，我刚刚开始参与联合开发一个包，其中使用了第一个和第三个选项。我注意到vignettes 文件夹中的.rmd 文件与docs 文件夹中的index.html 文件相同。pkgdown 是否从 vignettes 文件夹中复制？

同样对于这个包，当我从 github 安装（使用 build_vignettes=TRUE）时，我收到一条错误消息，提示安装失败，因为找不到 doc/index.html 路径。现在为什么会发生这种情况？

我们正在为我们的 R 包添加一个小插图。使用 记录包roxygen2时，小插图中断并给出错误

但是，使用devtools::document()or devtools::build_vignettes()，小插图构建得很好。

位于此处的最小示例。

我正在构建一个 R 包。我有几个小插曲，我想在我的 README.Rmd 中包含指向它们的链接。

我知道在安装软件包时可以选择构建小插图。

我真的不明白我应该从哪里开始。我正在 R Studio 中构建包。我希望用户能够通过单击 GitHub 上自述文件中的链接来查看小插图。这可能吗？如何？

以下显然不起作用。

我正在构建一个 R 包。

在此之后我收到以下错误

我不确定是什么导致了错误。我想因为它调用 roxygen2::roxygenize，它可能来自那里，但包不包含此错误消息。有人可以指导我解决这个问题吗？

在询问之前，我接受这个问题的许多部分已经在其他堆栈中被触及，并且我已经阅读了 Hadley Wickham inst 和 vignette 部分，但我仍在努力解决我的警告。抱歉，如果这个问题有点啰嗦，我会尽量做到彻底。

我的问题涉及我的 package_tutorial。

我得到的第一个警告是：

在 Hadley Wickham 的文档中，它声明“inst/docs：这是一个较旧的小插图约定，在现代包中应避免使用。” 那么为什么 CMD 检查要求将小插图放在 inst/doc 文件夹中？我将概述问题末尾附近的小插图和 inst 文件夹中的内容。

我收到的下一个警告如下：

我没有 doc 文件夹，因为很明显 inst/doc 文件夹已过时。当我在 inst/doc 文件夹中使用我的小插图进行 CMD 检查时，将删除 doc 文件夹。我知道这可能是重建过程的一部分。

可能有助于解决此问题的其他信息：

文件夹构造（仅适用于小插图和 inst 文件夹）：

包 - inst - extdata - package_tutorial.pdf

包 - inst - extdata - package_tutorial.Rmd

package - inst - extdata - plots - 小插图使用的几个图

包 - 小插图 - package_tutorial.pdf

包 - 小插图 - package_tutorial.Rmd

我尝试了不同的选项，即在 extdata 中没有 Rmd 文件，在 vignettes 文件夹中没有 pdf 文件，但这并没有解决问题。

YAML 元数据：

构建工具选项： Build and Reload - R CMD INSTALL 附加选项：

检查包 - R CMD INSTALL 附加选项：

构建源包 - R CMD INSTALL 附加选项：

我确实希望这是足够的信息来帮助我解决我的问题。我希望这是我从未见过的愚蠢的东西。非常感谢任何指导帮助。

我尝试按照https://cran.r-project.org/web/packages/R.rsp/vignettes/R_packages-Static_PDF_and_HTML_vignettes.pdf中的说明进行操作，其中显示了如何在cran的小插图中包含静态 pdf 。但是，在按照说明创建 PDF 和 asis 文件后，我在 Windows 上执行签入r时收到以下警告。 version 3.6.2

我该如何解决这个问题？我检查了，这些pdf中的每一个都在vignettes文件夹中，我还尝试将它们放入doc文件夹中，但仍然收到相同的警告。

文件夹结构和项目结构可以在这个 repo中看到