R帮助
R(右)有一个文档系统,确保为代码编写文档安装包时,将安装distributed as packages。可以从R本身调用和搜索此文档。
不同于Python语言docstring,其中的文档字符串可以在特殊属性中找到__文件__,R文档位于文档页面中对象的外部。每个文档页面至少关联一个别名,别名经常出现对应于包中定义的R对象的名称(函数、数据集等)。
例如,查询R函数的文档总和问题是找到哪个文档页具有别名总和,并检索该页面。
查询别名
使用R时,使用文档的常见用例是查询别名(函数名、数据集或类名)并检索相关文档。
而R打包系统将检查任何给定的别名只与同一包中的一个页面关联,这很好可能有几个包为相同的别名。
通过rpy2与帮助系统的接口,可以轻松检索与别名关联的页面是使用函数页面(),它返回一个元组属于第页实例。
-
rpy2.robjects.help。页(话题)[来源]
获取与给定主题对应的帮助页面。
程序包文档
包的文档用类表示包裹.
-
班rpy2.robjects.help。包裹(软件包名称,package_path=无)[来源]
基础:内置程序对象
包的R文档页面(也称为帮助)。
-
取来(别名)[来源]
获取与给定别名关联的文档页面。
对于S4类,类名为经常后缀为“-class”。例如,类文档的别名Biobase包中的AnnotatedDataFrame是“Annotated_DataFrame-class”。
-
名称
R已知的包名称
-
包路径
已安装R包的路径
>>>进口 rpy2.robjects.help 作为 相对湿度
>>>基本帮助(_H) = 相对湿度.包裹(“基础”)
>>>基本帮助(_H).取来(“总和”)
文档页面
文档页面表示为班第页.
-
班rpy2.robjects.help。第页(结构数据库)[来源]
基础:内置程序对象
R文档页面。原始R结构是一个嵌套的组件序列,对应于latex-like。Rd文件
帮助页面分为几个部分,这些部分的名称是dict属性“sections”和给定节的键可以用平方拍算子提取。
在R中,S3类“Rd”是与该类最接近的实体。
-
论据()[来源]
获取参数及其作为元组列表的描述。
-
描述()[来源]
获取条目的描述
-
iter项()[来源]
迭代器遍历节名称和内容在文档页面中。
-
另请参见()[来源]
获取推荐的其他文档条目
-
标题()[来源]
获得标题
-
to_docstring(section_names=无)[来源]
section_names:要考虑的节名称列表。如果没有使用所有部分。
返回可以用作Python文档字符串的字符串。
-
使用()[来源]
获取对象的用法
-
价值()[来源]
获取返回的值
>>>马力 = 基本帮助(_H).取来(“总和”)
>>>马力.部分.钥匙()
(“title”、“name”、“alias”、“keyword”、“description”、“usage”、“arguments”、“deta”
ils’,‘value’,‘section’,‘references’,’see also’)
注意
>>>打印(''.参加(马力.to_docstring(('详细信息',))))
细节-------这是一个泛型函数:可以为其定义方法直接或通过通用摘要组。要使其正常工作,参数应该是unnamed,dispatch位于第一个参数上。如果na.rm为FALSE,则为na任何参数中的值都将导致返回NA值,否则返回NA值被忽略。逻辑真值被视为一,假值被视为零。由于历史原因,NULL被接受并视为为整数(0)。