问题标签 [pkgdown]

在几个包中，最近matlib在 github 上的包https://github.com/friendly/matlib我有一个 README.{md,Rmd} 文件，上面写着类似

现在有一小部分小插曲可供使用。用browseVignettes("matlib")来看他们。

我想在 README 中用小插图名称及其标题列表替换或添加此内容。

在 README 中，我最接近我想要的信息的结果> vignette(package= "matlib")如下所示：

但是我想在一个块中捕获这个结果，或者我可以直接在 README 中使用。如果我使用 构建包站点pkgdown，我会在 **Articles* 下获得指向小插图的链接，但我仍然没有可以直接使用的小插图名称和标题列表。

我的包中的一个函数使用kable()and生成一个表格kable_styling()。当我运行此代码时，我在查看器中看到了输出，在控制台中看到了长 HTML 代码。我看到了在 Rmd 中排除 HTML 输出而不是函数的解决方案。它也只在我使用时显示代码pkgdown::build_site()

我试过了invisible()，sink()我正在使用最新版本的kableExtra（1.1.0）

我怎样才能让它只在查看器中显示结果并在函数的参考页面中正确显示？

我不确定如何表达这些pkgdown东西，但这应该足以取得一些进展。

有没有办法为网站{knitr}中创建的示例设置块选项{pkgdown}？

我想避免的一件事是打印消息和警告。在一个普通的 Rmarkdown 文档中，我会在顶部创建一个这样的块。

一段时间以来，我一直在愉快地使用 Github 的 Actions 来运行我的库R CMD check并部署包的文档。突然，打包操作开始失败，并出现以下错误：

我尝试使用我的姓名和来自 RStudio 终端的电子邮件运行这些命令，尝试从我编码的不同计算机上运行这些命令，检查pkgdown::deploy_to_branch()文档......但没有成功。

知道如何解决这个问题吗？我没看到什么？这是最近改变的东西的错误吗？

我正在开发一个包含 R 和 python 版本的包。

对于 R 包，我使用 pkgdown 作为文档。由于设计和易用性，我想保留 pkgdown。

将 R 和 python 的文档放在一起的最佳方法是什么？

我正在研究一个 R 包。它在我的 GitHub 上，但是在摆弄 pkgdown 以获得一个漂亮的网站之后，该包不再有效。具体来说，即使在加载包之后，其中的功能也不再可访问：

该软件包似乎加载正常。

bark 函数的帮助加载正常。

谁能帮我弄清楚发生了什么以及我哪里出错了？

我正在使用该pkgdown包为我的包生成一个网站。

我有一些函数有输出一些宽的例子data.frame。在.Rd包中包含的文件中，这不会导致任何问题，因为输出不会打印在帮助文件中。

但是，我希望在我的网站的参考部分中获得示例的输出。我想知道是否有任何方法可以将它们打印得很宽，并允许用户水平滚动整个代码块，而不是将它们打印在宽度较小的不同连续小块中。

基本上，我想知道是否可以添加一行代码来设置一个非常大的值，options("width")而不必在@examples我的每个函数的部分中显式地编写它。正如我上面写的，这对.Rd文件没有任何影响，因为输出没有写在任何地方，只写在显示输出的网站的参考部分。

抱歉，在我的问题中包含一个代表会非常复杂，但换句话说，我想从这个开始

对此

在网站的参考部分。

我有一个带有 pkg​​down 文档站点的 R 包。我想创建一个 git 钩子，以便如果我尝试提交和推送更改，README.Rmd或者index.Rmd不先编织它们以创建相应的.Md文件，我会收到警告。现在我只是忘记了。

R Packages一书说用于usethis::use_readme_rmd()创建 README，它也将创建 git 钩子。但我已经有一个 README.Rmd 文件。

通常如何为现有的 .Rmd 文件创建挂钩，无论是 README.Rmd 还是我的 pkgdown 站点中的 index.Rmd ？我想使用这个usethis包，但如果在那个包之外做起来更简单，我愿意接受。

我希望使用pkgdown生成分析网站，并希望在多个站点文章中使用大对象，而无需重新计算或保存.Rda文件以包含在包构建中（即data/x.Rda.

默认情况下，pkgdown::build_site()忽略vignettes带有前下划线的子目录中的文件。我当前的方法使用文件vignettes/articles.Rmd来执行一些生成大对象的计算，然后.html通过调用rmarkdown::render(). 看起来的内容是.Rmd这样的：

_pkgdown.yml可以修改以获取从 Rmarkdown 报告呈现的 html 文件，但它们会丢失.Rmd由pkgdown::build_site().

如果可能，我想在这些 Rmarkdown 报告中包含 pkgdown 站点 html 格式（即标题和站点导航栏）。

_pkgdown.yml内容：

我不确定是否有更好的方法来跨文章共享对象（尽管我知道这些通常是独立的）。这种方法有效，但是为 Rmarkdown 报告呈现的 html 页面会丢失 pkgdown 格式，从而导致站点导航栏丢失。

编辑：将在此处查看源代码：

https://github.com/r-lib/pkgdown/blob/master/R/build-articles.R

由于某种原因pkgdown，无法解析我的包中的 .Rd 文件之一。roxygen2当我使用@examples标签或@example inst/example/add.R替代方法向文档添加示例时，我发现它失败了。我将我的函数最小化为两个参数，以使其更“可重复”并且仍然得到相同的错误。请在下面找到错误消息、使用该消息生成 devtools::document()的 .Rd 文件以及该函数的 roxygen2 文档。如您所见，我正在使用一个非常简单的示例，该示例应该可以毫无问题地运行...还要说的是，当我运行devtools::check()所有示例时，我都通过了，所以我不明白为什么pkgdown会失败。

非常感谢你的帮助。

最好的，

错误信息

.Rd 文件

roxygen2 文档