promptClass
位於 methods
包(package)。 說明
組裝類的所有相關槽和方法信息,並以最少的 Rd 處理標記;目前沒有QC設施。
用法
promptClass(clName, filename = NULL, type = "class",
keywords = "classes", where = topenv(parent.frame()),
generatorName = clName)
參數
clName |
命名要記錄的類的字符串。 |
filename |
通常,一個連接或一個字符串,給出應寫入文檔 shell 的文件的名稱。默認對應的文件的名稱是類文檔的主題名稱,後跟 |
type |
要在輸出文件中聲明的文檔類型。 |
keywords |
要包含在文檔 shell 中的關鍵字。關鍵字 |
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
,或將編輯後的文件包含在‘男人’ 包的子目錄。
相關用法
- R promptMethods 生成用於形式方法文檔的 Shell
- R as 強製對象屬於某個類
- R language-class 表示未評估語言對象的類
- R className 類名包含對應的包
- R BasicClasses 基本數據類型對應的類
- R callGeneric 從方法調用當前通用函數
- R findClass 查找類定義
- R setOldClass 注冊舊式 (S3) 類和繼承
- R ReferenceClasses 具有按引用處理的字段的對象(OOP 樣式)
- R MethodsList 方法列表對象
- R setGroupGeneric 創建函數的組通用版本
- R StructureClasses 基本結構對應的類
- R showMethods 顯示指定函數或類的所有方法
- R getMethod 獲取或測試方法的定義
- R slot 正式類對象中的槽
- R S4groupGeneric S4組通用函數
- R methodUtilities 用於方法和 S-Plus 兼容性的實用函數
- R getClass 獲取類定義
- R evalSource 使用源文件中的函數定義,無需重新安裝包
- R is 對象是來自類嗎?
- R isSealedMethod 檢查密封方法或類
- R cbind2 按列或行組合兩個對象
- R GenericFunctions 管理通用函數的工具
- R dotsMethods 在方法簽名中使用...
- R S3Part 包含 S3 類的 S4 類
注:本文由純淨天空篩選整理自R-devel大神的英文原創作品 Generate a Shell for Documentation of a Formal Class。非經特殊聲明,原始代碼版權歸原作者所有,本譯文未經允許或授權,請勿轉載或複製。