當前位置: 首頁>>編程示例 >>用法及示例精選 >>正文


R promptClass 生成正式類文檔的 Shell

R語言 promptClass 位於 methods 包(package)。

說明

組裝類的所有相關槽和方法信息,並以最少的 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 函數一樣,除非 filenameNA ,否則文檔 shell 會寫入文件,並給出相關消息。該文件需要編輯以提供有關該類含義的信息。 promptClass 的輸出隻能包含來自元數據的有關正式定義及其使用方式的信息。

如果 filenameNA ,則會創建並返回文檔 shell 的列表樣式表示形式。將 shell 寫入文件相當於 cat(unlist(x), file = filename, sep = "\n") ,其中 x 是列表樣式的表示形式。

如果發現在類名或可選的 generatorName 下分配了生成器函數,則該函數的框架文檔將添加到文件中。

如果 filenameNA ,則為文檔 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,或將編輯後的文件包含在‘男人’ 包的子目錄。

相關用法


注:本文由純淨天空篩選整理自R-devel大神的英文原創作品 Generate a Shell for Documentation of a Formal Class。非經特殊聲明,原始代碼版權歸原作者所有,本譯文未經允許或授權,請勿轉載或複製。