R promptClass 生成正式类文档的 Shell

说明

组装类的所有相关槽和方法信息，并以最少的 Rd 处理标记；目前没有QC设施。

用法

promptClass(clName, filename = NULL, type = "class",
            keywords = "classes", where = topenv(parent.frame()),
            generatorName = clName)

参数

clName	命名要记录的类的字符串。
filename	通常，一个连接或一个字符串，给出应写入文档 shell 的文件的名称。默认对应的文件的名称是类文档的主题名称，后跟 ".Rd" 。也可以是NA(见下文)。
type	要在输出文件中声明的文档类型。
keywords	要包含在文档 shell 中的关键字。关键字"classes" 应该是其中之一。
where	在哪里查找类和使用它的方法的定义。
generatorName	此类的生成器函数的名称；仅当创建生成器函数并以与类名不同的名称保存时才需要。

细节

类定义可在搜索列表中找到。使用该定义，可以确定有关扩展类和槽的信息。

此外，还找到了当前可用的带有此类方法的泛型(使用 getGenerics )。请注意，这些方法不需要与类定义位于同一环境中；特别是，这部分输出可能取决于当前在搜索列表中的包。

与其他 prompt-style 函数一样，除非 filename 是 NA ，否则文档 shell 会写入文件，并给出相关消息。该文件需要编辑以提供有关该类含义的信息。 promptClass 的输出只能包含来自元数据的有关正式定义及其使用方式的信息。

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

如果发现在类名或可选的 generatorName 下分配了生成器函数，则该函数的框架文档将添加到文件中。

值

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

例子

## Not run: > promptClass("track")
A shell of class documentation has been written to the
file "track-class.Rd".

## End(Not run)

作者

VJ Carey stvjc@channing.harvard.edu and John Chambers

参考

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 用于函数文档，promptMethods 用于方法定义文档。

要处理已编辑的文档，请使用R CMD Rdconv，或将编辑后的文件包含在‘男人’ 包的子目录。