R promptData 為數據集生成大綱文檔

說明

生成數據集的文檔 shell 。

用法

promptData(object, filename = NULL, name = NULL)

參數

object	一個R要記錄為數據集的對象。
filename	通常，connection 或字符串給出應寫入文檔 shell 的文件名。默認對應於名稱為 name 後跟 ".Rd" 的文件。也可以是NA(見下文)。
name	指定對象名稱的字符串。

細節

除非 filename 是 NA ，否則 object 的文檔 shell 會寫入 filename 指定的文件中，並給出相關消息。

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

目前，代碼僅顯式處理數據幀。

值

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

例子

promptData(sunspots)
unlink("sunspots.Rd")

也可以看看

prompt