如何使用Roxygen从不同的包中正确记录泛型的S3方法？
Roxygen是一个用于R语言的文档化工具，它可以帮助开发者生成规范的文档，并且支持记录泛型的S3方法。下面是使用Roxygen从不同的包中正确记录泛型的S3方法的步骤：
- 在R包的源代码文件中，找到包含泛型函数定义的文件。通常，这些文件的命名规则是以泛型函数名开头，后面跟着一个点号（.）和字母“R”。
- 在泛型函数定义的文件中，使用Roxygen的注释语法来记录泛型函数的文档。注释应该放在函数定义的上方，并以“#'”开头。
- 在Roxygen注释中，使用@export标记来指示该函数是一个导出的泛型函数。这样，其他包就可以使用该泛型函数。
- 在Roxygen注释中，使用@method标记来记录具体的S3方法。@method标记后面应该跟着泛型函数的名称和方法的类别。例如，@method print.myclass表示定义了print方法，该方法适用于myclass类的对象。
- 在Roxygen注释中，使用@examples标记来提供示例代码，展示如何使用泛型函数和S3方法。
- 运行Roxygen来生成文档。可以使用devtools包中的document()函数来自动生成文档。运行document()函数后，Roxygen会解析源代码文件中的注释，并生成相应的文档。
- 在生成的文档中，可以查看泛型函数和S3方法的详细说明、参数列表、示例代码等信息。
总结起来，使用Roxygen从不同的包中正确记录泛型的S3方法的步骤包括：找到泛型函数定义的文件，使用Roxygen注释语法记录泛型函数的文档，使用@export标记导出泛型函数，使用@method标记记录具体的S3方法，使用@examples标记提供示例代码，运行Roxygen生成文档，查看生成的文档中的泛型函数和S3方法的详细信息。
腾讯云相关产品和产品介绍链接地址：
- 腾讯云官网：https://cloud.tencent.com/
- 云服务器（CVM）：https://cloud.tencent.com/product/cvm
- 云数据库 MySQL 版：https://cloud.tencent.com/product/cdb_mysql
- 云原生应用引擎（TKE）：https://cloud.tencent.com/product/tke
- 云存储（COS）：https://cloud.tencent.com/product/cos
- 人工智能（AI）：https://cloud.tencent.com/product/ai
- 物联网（IoT）：https://cloud.tencent.com/product/iotexplorer
- 移动开发（移动推送、移动分析、移动测试等）：https://cloud.tencent.com/product/mobile
- 区块链（BCS）：https://cloud.tencent.com/product/bcs
- 元宇宙（Tencent Real-Time Rendering Engine）：https://cloud.tencent.com/product/trre
相关·内容
我正在编写一个包，它定义了一个新的类、测量者和一个print方法，即print.surveyor。我的代码运行良好，我使用roxygen作为内联文档。但R CMD check发出警告：
我使用了以下两页，由Hadley编写，作为灵感：和，这两个页面都声明正确的</e
浏览 2提问于2011-06-29得票数 49
回答已采纳
2回答
我正在开发的包中有以下依赖链：
我的包使用在包A (trajectory)中定义的类(simmer)。它还为该类(plot.trajectory)使用了一个plot.trajectory方法，它是在包B (simmer.plot)中定义的。我可以将包A作为一个整体导入，但不能将包B作为一个整体导入，因为它包含对包</
浏览 2提问于2020-01-08得票数 4
回答已采纳
我有一个R包(目前不在CRAN上)，它从其他包(特别是S3和huxtable::as_huxtable)中定义了几个泛型函数的huxtable::as_huxtable方法。但是，它们不是我的包的关键部分，所以当用户安装我的包时，我不希望创建这些包的依赖关系。在R4.0.0之前，我不导入泛型就导出了S3
浏览 2提问于2020-04-28得票数 8
回答已采纳
4回答
我正在创建一个包，对于S3方法，我使用以下命令导出它们##' @export现在，当我加载包时，predict在类myclass的对象上工作，但是函数predict.myclass不会被导出。那么，有没有一种方法可以导出predict.myclass，这样当用户在控制台中编写predict.mycl
浏览 7提问于2013-08-29得票数 22
1回答
我有一个，它为其对象提供了一个as.FlexTable方法，从ReporteRs包扩展了S3泛型。因此，由roxygen生成的我的命名空间文件有几行：...S3method(as.FlexTable,huxtable)export(as.FlexTable)
我不太想把记者放在Imports中:在描述文件中，因为它涉及
浏览 1提问于2017-03-14得票数 2
回答已采纳
我已经阅读了Roxygen2 PDF以及这篇，我对@method @S3method @export之间的区别以及如何使用这些方法正确地记录S3方法感到迷惑。我在下面的例子中进行了讨论：如何模拟文档?print和其他显示所有类特定实现用例的泛型函数(即?print显示'factor‘、&#x
浏览 0提问于2011-08-26得票数 54
回答已采纳
我有两个用于S3泛型的方法(在另一个包中定义)，它们紧密相关，因此我想将它们记录在同一个Rd文件中。但是，当我单独记录它们参数时，我收到来自R CMD check的关于“文档对象中重复的\参数条目”的警告。然而，对于不同的方法，它的文档是不同的</e
浏览 3提问于2012-04-11得票数 23
自从roxygen2版本4.0.0之后，@S3method标记就被废弃了，而倾向于使用@export。这个包现在尝试检测一个函数是否是S3方法，如果它认为它是一个NAMESPACE文件，它会自动将行S3method(function,class)添加到NAMESPACE文件中。问题是，如果一个函数不是一个S3方法，但是它的名称包含一个.，那么roxygen有时会出错，在不应该的时候添加行。
有没有办
浏览 2提问于2014-07-06得票数 22
回答已采纳
这个问题与相关但又不同。从那篇文章中，我了解到需要使用@export function.name才能让roxygen正确地编写命名空间。我已经这样做了，命名空间是正确编写的。我的问题出现在我做R CMD检查的时候。我有一个具有tail.g()函数的遗留代码。R Check抛出一个注释，指出一个明显的S3方法已被导出但未注册。
下面是一个可重复使用
浏览 5提问于2016-12-09得票数 4
在名称空间文件(用roxygen2::document()创建)中，这些函数仅作为S3method导出，而不是以S3method的形式导出，并且不被sloop::is_s3_method识别。我在网上搜索，找不到答案或明确的例子。按照我的R脚本中的，我只是记录了添加#' @export print.marco等函数。(marco_obj){ }
从上面提到的<
浏览 2提问于2020-07-27得票数 0
回答已采纳
1回答
simulate()方法定义为S3方法的定义。因为已经定义了用于模拟的泛型，所以我只是定义了一个simulate.myclass (在我的例子中是)。
该包还依赖于另一个具有S4版本模拟的包。当加载我的包时，我会得到上面的S4版本错误。创建R目录，添加一个简单的R脚本(我已经包含了生成前面提到的名称空间
浏览 6提问于2012-01-16得票数 5
1回答
记录现有泛型的新S4方法
、、、
我想为plot泛型记录一个新的方法。问题是，如何为标准泛型记录新方法。document = FALSE)Undocumented S4 methods:这是我的代码(R 4.0.3，roxygen2 7.1.1)：
#'
浏览 14提问于2021-02-16得票数 0
回答已采纳
在我的玩具包中，我将%+%操作符定义为paste0()的别名。为了减少对其他软件包的干扰，我以以下方式意识到这一点：# testab2() is defined in R file as a part of the package:}
# whe
浏览 0提问于2020-10-02得票数 5
回答已采纳
2回答
实际问题
S4泛型及其方法是，而不一定都定义在同一个包中(包含(某些)自定义方法的包依赖于包含泛型的包)和。使用包roxygenize()从生成实际的Rd文件？当泛型及其方法分散在包中
浏览 0提问于2012-10-30得票数 58
2回答
我已经阅读了以下两个讨论：
但是我的问题仍然没有解决。以下是详细信息：#' description#' more details#' @param x "test" objectplot.test <- function(x, label=TRUE, l
浏览 7提问于2018-03-07得票数 5
我正在为文档编写一个使用的包。我在记录S4方法时遇到了一些困难。我已经定义了一个通用的方法(例如，myGeneric)，并且很少有实现它的方法。
问题：是否有一种方法可以自动记录一个泛型的所有方法？手动解决方案是为每个方法添加这两行(这将是我的虚拟示例中的第
浏览 5提问于2014-06-16得票数 9
1回答
我有一个R6类myclass，并且我已经为它定义了S3泛型as.matrix。section 'Registering S3 methods' in the 'Writing R Extensions'#'
#&
浏览 21提问于2020-04-22得票数 2
回答已采纳
1回答
我为我在包中定义的show()类myclass编写了一个myclass方法。我用roxygen2生成了类和方法的文档。除了在R CMD检查结果中得到以下警告外，一切都运行得很好：
无文档的S4方法:泛型‘长度’和σ列表'myclass‘
如何编写我自己没有写的show泛</
浏览 0提问于2018-03-21得票数 1
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
腾讯会议
实时音视频活动推荐
腾讯云开发者
