问题标签 [pkgdown]

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 回答
20 浏览

html - 如何在 {pkgdown} 站点中手动创建链接?

自动链接小pkgdown 插图详细介绍了包如何在网站中创建链接,包括到网站本身的其他页面和其他包的文档。我想知道是否有一种简单的方法可以复制它。例如,在构建站点时是否有可以在其中运行的功能,类似的东西generate_pkgdown_link("my_function")会创建这样的链接。这将非常有用,例如用于创建描述包结构的 HTML 流程图等。

请注意,查看自动生成的链接并生成看起来相同的内容相对简单。主要困难在于生成一个无论站点托管在哪里都可以工作的链接——例如,它是托管在本地还是托管在 RStudio Connect 服务器上。

0 投票
1 回答
61 浏览

r - 如何将额外文件添加到 pkgdown 站点?

我有一个包含一些 Javascript 代码和 R 代码的包。我可以pkgdown通过正确设置和运行来为包中的 R 文档构建一个由 Github 托管的网站

我还可以JSDoc用来建立一个记录 Javascript 代码的本地网站,并将其放在使用的docs目录中pkgdown,并带有来自其他部分的链接。这在本地工作,但是当我使用上面的命令将它部署到 Github 时,不包含 JSDoc 文件。

我如何告诉pkgdownJSDoc文件包含在它部署到 Github 的网站中?

这个问题真的无关JSDoc; 我可以将其视为具有我想要部署的文件的子目录以及生成的所有文件pkgdown

0 投票
1 回答
38 浏览

r - pkgdown 无法构建 Vignette

我有一个我正在尝试设置的 R 包pkgdown。我正在按照此处的说明进行操作,并正在运行build_site()以生成 docs 目录。运行此命令时,我收到错误

显示在尝试渲染其中一个小插曲时构建失败。但是,如果我只是尝试在新的交互式会话中编织这个小插曲,它会很好地编织。

我尝试在 Depends、Imports 或 Suggests 中包含 DiagrammeR 和 DiagrammeRsvg,但它仍然失败并出现同样的错误。

知道我能做些什么来解决这个问题吗?小插图位于我的 github。我知道这不是分享示例的理想方式,但它可以通过克隆 repo 并运行来重现pkgdown::build_site()

0 投票
1 回答
23 浏览

r - pkgdown 错误:使用 tag_code 中的未定义标记

在尝试使用 pkgdown 为我的软件包构建网站时,我遇到了一条我不理解的错误消息。

正如指令(https://pkgdown.r-lib.org/)所说:

我跑过usethis::use_pkgdown()一次。

当我运行时pkgdown::build_site()没有任何反应,然后我收到错误消息Undefined tag in usage tag_code

谷歌搜索错误消息没有帮助,我不知道从哪里开始在我的包中查找错误。有谁知道在这种情况下该怎么办?用文件记录devtools::document()工作正常,也是如此devtools::load_all()

我真的不知道如何从中制作一个reprex,所以如果您需要更多信息,我很乐意提供。

提前致谢!

0 投票
0 回答
25 浏览

r - 如何为 R 包小插图创建关键功能表

我想为 R 包的小插图添加一个“关键”函数表,看起来在记录函数时,我已经完成了大部分工作。是否有一个快速小部件可以让创建这个表格变得非常快速和容易?

到目前为止,我可以看到pkgdown::build_reference()它对创建一个包网站做了类似的事情;我正在寻找这个函数的一个版本,它可以让我在vignette中生成一个表格。例如,我会为一组选定的概念生成一个包含函数、它们的“概念”(带有注释@concept中的标签roxygen2)、描述和参数列表的表。如果有一个工具可以做到这一点,你能指点我这个工具吗?如果没有,您是否有包装或解决方法?

谢谢!

0 投票
0 回答
9 浏览

html - LaTeX 方程(svg 图像)在 Safari 12.1.1 上显示“不支持插件”?

我为我的R包 GitHub创建了一个pkgdown站点: https ://zhengxiaouvic.github.io/rmBayes/

我用来.Rmd编织的设置.md

LaTeX 方程在 Chrome、Firefox 和 IE 网络浏览器上看起来不错,但在 Safari 上显示“不支持的插件”(版本 12.1.1 (14607.2.6.1.1)) 在此处输入图像描述

我该如何解决这个问题?感谢您的任何评论。

0 投票
1 回答
25 浏览

r - pkgdown::deploy_to_branch() SSL 证书错误

我已经使用pkgdown::deploy_to_branch()了一段时间在gh-pages我的 repo 的分支上发布我的文档,但是截至本周它停止工作并开始给我以下错误:

当我尝试调试并深入了解该函数时,这是我尝试build_site()直接调用的错误:

build_site() 堆栈跟踪

诚然,各种身份验证一直让我感到困惑,但真正让我感到困惑的是,我与 github 的身份验证似乎以所有其他方式工作。我用 SSH 克隆了它。当我手动或通过 RStudio GUI 进行操作时,我可以随心所欲地推动和拉动。此外,我无法弄清楚自此工作以来发生的任何变化

无论如何,非常感谢任何帮助。我还查看了在搜索错误时出现的其他一些问题(例如, this one),但它们似乎与我的情况无关,git 工作正常,除了在这个调用中。

一些细节:

  • 我在 Ubuntu 18.04.5 LTS (GNU/Linux 5.4.0-1054-aws x86_64)
  • R 4.0.3
  • pkgdown 1.6.1
  • 我尝试使用两个不同的存储库(12,它们以前都使用相同的命令和相同的操作系统/版本/等 ^

让我知道是否有更多的细节会有所帮助。谢谢!

0 投票
1 回答
63 浏览

r - 无法将包网站(来自 R 的 pkgdown)推送到 GitHub

我使用 pkgdown 包为我的包创建了一个新网站,该网站将托管在 Github 上。
我运行了以下代码:

该函数在我的本地仓库pkgdown::build_site中生成了一个子文件夹。docs\您可以在下面的照片中看到(红色箭头)。我需要将此docs\子文件夹推送到我的 Git 存储库,但我不知道为什么docs\子文件夹没有显示在我的Git commit面板上。所以现在我无法在 GitHub 上推送我的网站。
在此处输入图像描述

有人可以帮我找出问题所在吗?以及如何解决这个问题?
我已经pkgdown使用以下命令安装了软件包:

但是,我无法安装 GitHub 的开发版本。是这个原因吗??我尝试安装,但出现以下错误:

0 投票
0 回答
108 浏览

r - 尝试使用 pak 安装 pkgdown 开发版本时,在 GitHub 操作中安装 rlang 失败

我正在使用以下 YAML运行 GitHub 操作,该操作应构建和部署 pkgdown 网站。

这个动作效果很好,最后一次是 8 天前。但是几天以来,它在依赖项的安装阶段失败了。我将提供相关控制台输出的屏幕截图以及失败阶段的完整日志。

GitHub 操作控制台输出的屏幕截图(下面的完整日志)

当我试图解决这个问题时,我发现至少另一个包 (httr2) 有 完全相同的问题

我认为这可能与当前 rlang 开发版本的版本号的最近更改有关,但我完全不知道为什么或如何修复它。由于我不确定问题的最终来源,因此我没有创建 GitHub 问题,而是在这里试试运气。

我目前的解决方法是从我的本地计算机构建和部署网站,但我觉得应该对此进行调查。

0 投票
1 回答
54 浏览

r - pkgdown::build_site() 未在 HTML 渲染中捕获 R 包徽标

我最近买了一台装有 Windows 11 的新笔记本电脑(尽管我 sessionInfo() 说的是 Windows 10),我正在尝试为pkgdown我正在开发的 R 包构建一个站点。这不是我过去遇到的问题。运行该命令pkgdown::build_site()不会正确地将我的自定义徽标链接到此 R 包的 HTML 站点。

下面的自定义徽标 png,供后代使用: brConnectR 徽标

man/figures/logo.png文件是生成的,usethis::use_logo("path/to/logo.png")并且网站图标是作为该pkgdown::build_site()过程的一部分生成的,但是,结果docs/index.html无法捕获任何徽标。下面是我的sessionInfo()

任何指针将不胜感激!