问题标签 [rd]

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 投票
0 回答
136 浏览

r - 在 R 包文档文件中包含图像

事实上,我和 Teema Daniel Laajala 有同样的问题,但提供的答案对我不起作用。

问题是关于在 R 包文档中显示图像。当我编写与?par 文档文件中完全相同的代码时,即:

图像不显示,我只能看到:imagenotdisplayed

虽然,我做了与上面完全相同的代码,将我的图像放在文件夹 man 中的文件夹图形中......所以我想知道如果我错过了什么,比如我应该安装的包或其他东西......

谢谢你的帮助 !

0 投票
1 回答
96 浏览

r - Roxygen2 文档参数乱序

我正在使用 Roxygen2 进行文档编制,但我无法让参数的顺序正确。具体来说,我为这一组方法设置了 3 组参数:

  • “n”:所有函数的参数,应该总是第一个
  • “r”:一些函数的参数,应该总是第二个。在模板中
  • p3-p5:模板中的一组参数;应该总是在结尾。
    • 它们分别以“s”、“a”和“r”开头

我无法将其按正确顺序排列:最常见的顺序是 n、p3-p5、r。如果我删除 n,我得到 p3-p5, r。如果我有 2 个 n,我得到 n,p3-p5,n,r。如果我有 2 个 r 而没有 n,我得到 p3-p5, r, r。

有关如何解决此问题的任何建议。如果您认为它与当前布局有关,它是:

其中 t2 的布局是:

我发现的其他修复似乎不起作用。另外,我希望 n 成为 t2 模板的一部分,但我认为这是不合理的。

0 投票
1 回答
112 浏览

r - 如何获取一个函数对应的Rd文档文件

我们如何获得现有函数(的内容*.Rd)的 R 文档的来源,比如plotlubridate::ymd. 类似于fix函数的文档的东西?

0 投票
1 回答
39 浏览

r - 风格不一致的 Rd 使用部分

新版本的roxygen2包对我的包的文档文件进行了重大更改。例如,组合在一个.Rd文件中的四个函数的“使用”部分如下所示:

请注意,第一个、第三个和第四个函数在一行中显示它们的参数,而第二个函数的参数以堆叠格式显示。这似乎不一致。以前的版本显示了第二个函数的参数未堆叠(但当然包含了几行)。

我希望我的文档保持一致。如果一个函数的用法呈现像这样堆叠的参数,它们都应该。但我真的宁愿没有一个被堆叠。我怎样才能控制这是如何完成的?

0 投票
1 回答
62 浏览

css - 在每个 .Rd 文件中自动调用宏或插入模板

我正在使用 roxygen 来记录一个 R 包。我在包的“man/macros”子目录中有一个宏文件 myMacro.Rd。该文件指定\myMacro宏。(该宏<style>在 HTML 帮助文件中插入一个标签,以更改 R 帮助文件中的标准 CSS。)

我想自动调用\myMacro包的每个 .Rd 文件。也就是说,我不想手动添加\myMacro(或其他任何东西)到我所有的 roxygen 代码中。相反,我希望自动添加。有没有办法做到这一点?

我可以通过自动将 Roxygen 模板插入到每个 .Rd 文件中来实现相同的效果。有没有办法做到这一点?

0 投票
1 回答
155 浏览

r - 有没有办法将github上的Rd文件在线转换为pdf

我正在尝试将 Rd 文件转换为 Pdf,以便我可以阅读它。这是 Rd 文件的链接:

https://raw.githubusercontent.com/helske/walker/master/man/walker_glm.Rd

我是 R 工作室的新手,所以如果我需要加载任何包,请告诉我。谢谢您的帮助。

0 投票
0 回答
23 浏览

r - R包文档:方法@family交叉引用的过度框

roxygen2用来记录我的 R 包texreg。在包中,我定义了一个通用 S4 函数extract以及许多增强其他 R 包功能的方法。在文档中,我使用@family extract标签创建交叉引用,这些交叉引用出现在每个方法相应帮助页面底部的“另请参阅”下。这是自动创建的 PDF 手册的示例屏幕截图:

在此处输入图像描述

如您所见,文档中有过多的框,有些甚至触及页面边框。这本身并不会让我太困扰(尽管显然它看起来并不专业)。但它发生在手册的大部分 204 页上,这导致了一个巨大的日志文件。这样做的结果是 travis-ci 不再在 GitHub 上成功构建包。它以以下日志结束:

这是不幸的,因为它不仅看起来很丑,而且还阻止了包的自动化测试。@family除了不按预期使用的明显选择(从而限制用户对包功能的概述)之外,我该如何解决这个问题?

0 投票
1 回答
57 浏览

r - 记录定义同名函数的包

我正在编写一个名为的包foo,它定义了一个foo以各种 S3 方法命名的 S3 类。我编写了一个foo()返回foo对象的构造函数。在包之后命名类,在类之后命名函数似乎很实用,我希望:

  • package?foo会调出包帮助页面。
  • ?foo?foo::foo会弹出功能帮助页面。

但发生的事情是:

  • 两者package?foo?foo调出软件包帮助页面。
  • ?foo::foo调出功能帮助页面。

有没有办法给包和函数赋予相同的名称以产生我想要的行为?

目前我有一个foo_package.R这样的文件:

和这样的文件foo.R

任何提示表示赞赏...

0 投票
0 回答
34 浏览

r - 数据/文件夹R包中的.Rdata文件中有两个R对象?

我正在通过 R CMD 检查警告,目前正在努力处理以下警告消息:

现在,我的 R 包骨架中的 data/ 文件夹中有一个 .RData 文件,其中包含 2 个 - 而不仅仅是 1 个 - 在您加载 RData 内容时加载的 R 对象。但是,我找不到任何文档告诉我如何声明这两个 R 对象,以便在我 roxgenise() 并执行后续 R CMD 检查时手册页可以找到它。

到目前为止,我正在尝试使用“@format”标签在数据集手册页中记录两个 R 对象。我也尝试了“@return”标签而不是“@format”,但警告仍然存在。我注意到它喜欢当 R 对象的名称与 RData 文件的名称匹配时。因此,Miller2015 R 对象未报告为未记录,但诊断 data.frame 是。

我可以做些什么来解决这个警告,而不必将 R 对象分解为单独的 RData 文件?什么是最佳实践?

0 投票
1 回答
178 浏览

r - 检查期间未找到导出的 S3 方法

在一个包中,我有一个foo返回类对象的函数"foo"。我也有一个plotclass 的方法"foo"

在使用devtools::load_all. 然而,devtools::check抱怨:

似乎我的 R 会话知道plot.foo,但不知道devtools::check。到底是怎么回事?


编辑:为了澄清,当devtools::checkplot.foo(foo_object)@examples. plot(foo_object)这并不让我感到惊讶,无论如何用户都应该调用泛型。我的问题仍然存在:为什么devtools::check无法找到plot.foo,因为我已经使用了@export标签并S3method(plot, foo)出现在NAMESPACEafter devtools::document