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