R prompt 生成 R 文檔文件的原型

說明

促進文件記錄的構建R對象。

用法

prompt(object, filename = NULL, name = NULL, ...)

## Default S3 method:
prompt(object, filename = NULL, name = NULL,
       force.function = FALSE, ...)

## S3 method for class 'data.frame'
prompt(object, filename = NULL, name = NULL, ...)

promptImport(object, filename = NULL, name = NULL, 
	importedFrom = NULL, importPage = name, ...)

參數

object	一個R對象，通常是默認方法的函數。可missing當name被指定。
filename	通常，connection 或字符串給出應寫入文檔 shell 的文件名。默認對應於名稱為 name 後跟 ".Rd" 的文件。也可以是NA(見下文)。
name	指定對象名稱的字符串。
force.function	一個合乎邏輯的。如果 TRUE ，則在任何情況下都將 object 視為函數。
...	傳入或傳出其他方法的進一步參數。
importedFrom	命名從中導入 object 的包的字符串。如果 object 是函數，則默認為 object 環境。
importPage	命名包中幫助頁麵的字符串，從中導入 object。

細節

除非filename是NA，一個文檔 shell object寫入指定的文件filename，並給出有關此的消息。對於函數對象，此 shell 包含正確的函數和參數名稱。由此創建的 R 文檔文件仍然需要編輯並移動到‘男人’包含要記錄的對象的包的子目錄。

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

當 prompt 用於 for 循環或腳本中時，顯式 name 規範將很有用。

importPage論證promptImport需要給出原始幫助頁麵的幫助文件名稱的基數。例如，approx函數記錄在‘approxfun.Rd' 在裏麵stats包，所以如果它被導入並重新導出它應該有importPage = "approxfun"。從其他包導入的對象通常不會被記錄，除非重新導出。

值

如果 filename 是 NA ，則為文檔 shell 的列表樣式表示形式。否則，寫入的文件名會以不可見的方式返回。

警告

默認文件名在有限的文件係統(例如 Windows 上的文件係統)下可能不是有效的文件名。

目前，正在調用prompt在非函數對象上假設該對象實際上是一個數據集，因此將其記錄為數據集。這可能會在未來版本中改變R.采用promptData為數據集創建文檔框架。

注意

prompt.data.frame 生成的文檔文件與 base 包中的許多數據幀文檔文件的格式不同。我們正在嘗試確定文檔的首選格式。

例子

require(graphics)

prompt(plot.default)
prompt(interactive, force.function = TRUE)
unlink("plot.default.Rd")
unlink("interactive.Rd")

prompt(women) # data.frame
unlink("women.Rd")

prompt(sunspots) # non-data.frame data
unlink("sunspots.Rd")


## Not run: 
## Create a help file for each function in the .GlobalEnv:
for(f in ls()) if(is.function(get(f))) prompt(name = f)

## End(Not run)

作者

Douglas Bates for prompt.data.frame

參考

Becker, R. A., Chambers, J. M. and Wilks, A. R. (1988) The New S Language. Wadsworth & Brooks/Cole.

也可以看看

promptData,help以及“編寫 R 擴展”中的“編寫 R 文檔”一章(請參閱“文檔/手冊’的子目錄R源樹)。

要創建許多幫助頁麵(針對包)，請參閱 package.skeleton 。

要提示用戶輸入，請參閱 readline 。