R promptMethods 生成用于形式方法文档的 Shell

说明

为通用函数的方法生成文档 shell 。

用法

promptMethods(f, filename = NULL, methods)

参数

f	命名要记录其方法的通用函数的字符串。
filename	通常，一个连接或一个字符串，给出应写入文档 shell 的文件的名称。默认值对应于这些方法的编码主题名称(当前为 f 后跟 "-methods.Rd" )。也可以是FALSE 或NA(见下文)。
methods	可选的 "listOfMethods" 对象提供要记录的方法。默认情况下，使用此泛型的第一个方法对象(例如，如果当前全局环境具有 f 的某些方法，则将记录这些方法)。 如果提供此参数，则可能是 findMethods(f, where) ，其中 where 是一些包含 f 方法的包。

细节

如果 filename 是 FALSE ，则返回创建的文本，可能会插入一些其他文档文件，例如通用函数本身的文档(请参阅 prompt )。

如果 filename 是 NA ，则会创建并返回文档 shell 的列表样式表示形式。将 shell 写入文件相当于 cat(unlist(x), file = filename, sep = "\n") ，其中 x 是列表样式的表示形式。

否则，文档 shell 将写入 filename 指定的文件。

值

如果 filename 是 FALSE ，则生成文本；如果 filename 是 NA ，则为文档 shell 的列表样式表示形式。否则，写入的文件名会以不可见的方式返回。

参考

Chambers, John M. (2008) Software for Data Analysis: Programming with R Springer. (For the R version.)

Chambers, John M. (1998) Programming with Data Springer (For the original S4 version.)

也可以看看

prompt 和 promptClass