R promptPackage 生成包文檔的 Shell

說明

使用 Rd 宏生成包概述幫助頁麵的原型，該宏在構建包時動態地從包元數據中提取信息。

用法

promptPackage(package, lib.loc = NULL, filename = NULL,
              name = NULL, final = FALSE)

參數

package	character 字符串，其中包含要記錄的包的名稱。
lib.loc	被忽略。
filename	通常，connection 或字符串給出應寫入文檔 shell 的文件名。默認對應於名稱為 name 後跟 ".Rd" 的文件。也可以是NA(見下文)。
name	指定幫助主題名稱的字符串；默認為‘⁠<pkgname>-package⁠’，這是必需的⁠\alias⁠獲取概述幫助頁麵。
final	一個邏輯值，指示是否嘗試創建幫助主題的可用版本，而不僅僅是一個 shell。

細節

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

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

如果 final 是 TRUE ，生成的文檔將不包含用於手動編輯的 place-holder 插槽，它將按原樣使用。在大多數情況下，手動編輯的文件是更好的選擇(但 final = TRUE 的工作量肯定更少)。

值

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

例子

filename <- tempfile()
promptPackage("utils", filename = filename)
file.show(filename)
unlink(filename)

也可以看看

prompt , package.skeleton