如何在R中查看类方法的可用参数和文档?

如何在R中查看类方法的可用参数和文档?,r,R,对于一个类方法,我们如何更普遍地查看所有可用参数或查看文档 例如,如果我们查看print的参数 打印 x 用于选择方法的对象。 ... 传递给其他方法或从其他方法传递的其他参数。 引用 逻辑,指示字符串是否应使用周围的引号打印。 -为简洁起见,将其他人排除在外- 使用源 逻辑指示当存在时是否应使用内部存储的源进行打印,例如,是否已使用optionScope.source=TRUE。 请注意,我们没有看到有关参数max\n的任何文档 现在假设我们在类xml_节点上调用print,例如: 一个是类

对于一个类方法,我们如何更普遍地查看所有可用参数或查看文档

例如,如果我们查看print的参数

打印 x 用于选择方法的对象。 ... 传递给其他方法或从其他方法传递的其他参数。 引用 逻辑,指示字符串是否应使用周围的引号打印。 -为简洁起见,将其他人排除在外- 使用源 逻辑指示当存在时是否应使用内部存储的源进行打印,例如,是否已使用optionScope.source=TRUE。 请注意,我们没有看到有关参数max\n的任何文档

现在假设我们在类xml_节点上调用print,例如:

一个是类xml_nodeset,如果我们调用printa,它只打印20个结果,这是因为我认为xml_nodeset类的配置使得当对它调用print时,它只返回20个结果。“20”号

在类xml_nodeset的对象上调用print时,我们如何找到有关print行为的特定文档?最好通过RStudio/手册


请注意,上面的示例只是一个随机示例,我想找到一种查找所有类方法文档的通用方法

您可以通过运行methodsprint查看所有特殊版本的print。这些版本的格式通常为。。这里列出的许多文件都有星号,这意味着它们不是直接从定义它们的包中导出的。如果他们有文档,您可以通过?print.rle访问文档。在这种情况下,没有print.xml_nodeset函数的文档。但是,如果您获取anywhere print.xml_节点集,或者如果您碰巧知道它来自xml2名称空间,那么您可以使用三个冒号来执行xml2:::print.xml_节点集

还有一个sloop包,它可以告诉您将为给定调用调用哪个S3方法。比如说

sloop::s3_dispatch(print(a))
=> print.xml_nodeset
 * print.default

您可以向软件包维护人员提出问题,要求提供功能文档,但是,如果作者没有包含文档,R就不能真正提供文档。

可以这样说吗?print.rle只是返回了?rle的文档?@stevec请注意,这两个函数是如何记录在页面顶部的,它显示了这两个函数的参数。如果可用,打印功能通常记录在创建要打印的对象类型的同一页上。这里有很多有价值的信息。如果我理解正确,一般做法是尝试?function.class,例如?print.rle。ii如果上一步没有返回任何文档。。etc,然后通过xml2:::print.xml_nodeset或getanywhere print.xml_nodeset查找源代码。这是一个合理的通用方法吗?另外,想知道*print.default在使用sloop时告诉我们什么?是的,这是一种很好的通用方法。s3_分派函数向您展示了所有可能考虑的s3方法,并突出显示了所选择的方法。因此,如果print.xml_nodeset函数不存在,它应该改为print.default?时间过得很慢,还是有你推荐的推荐信?
sloop::s3_dispatch(print(a))
=> print.xml_nodeset
 * print.default