R package.skeleton 為新的源包創建骨架

說明

package.skeleton自動執行新源包的一些設置。它創建目錄，將函數、數據和 R 代碼文件保存到適當的位置，並創建骨架幫助文件和“Read-and-delete-我’文件說明了打包的進一步步驟。

用法

package.skeleton(name = "anRpackage", list,
                 environment = .GlobalEnv,
                 path = ".", force = FALSE,
                 code_files = character(), encoding = "unknown")

參數

name	字符串：您的包的包名稱和目錄名稱。必須是有效的包名稱。
list	字符向量命名R要放入包中的對象。一般情況下，最多可以有一個list,environment， 或者code_files將被供應。查看具體信息'。
environment	尋找物體的環境。查看具體信息'。
path	放置包目錄的路徑。
force	如果FALSE不會覆蓋現有目錄。
code_files	一個字符向量，其中包含用於構建包的 R 代碼文件的路徑。查看具體信息'。
encoding	可選地character帶有可選‘編碼的字符串⁠編碼：⁠' 行中 'DESCRIPTION’ 當使用非 ASCII 字符時；通常是其中之一"latin1","latin2"， 或者"UTF-8";請參閱 WRE 手冊。

細節

參數 list 、 environment 和 code_files 提供了初始化包的替代方法。如果提供了code_files，則將獲取如此命名的文件來形成環境，然後用於生成包框架。否則， list 默認為 environment 中的對象(包括名稱以 . 開頭的對象)，但可以用於選擇該環境中的對象子集。

使用 prompt 、 promptClass 和 promptMethods 函數為函數、數據對象以及 S4 類和方法生成幫助文件存根。如果打算在不進行任何更改的情況下導入和重新導出另一個包中的對象，則應在 package.skeleton 之後使用 promptImport 函數來生成鏈接到原始文件的簡單幫助文件。

包源放置在 path 的子目錄 name 中。如果提供code_files，則複製這些文件；否則，對象將被轉儲到單獨的源文件中。 code_files 中的文件名應具有後綴 ".R" 並且位於當前工作目錄中。

為源代碼和文檔創建的文件名嘗試對所有已知運行的操作係統有效R。無效字符被替換為‘⁠_⁠”，無效名稱前麵帶有“⁠zz⁠'，名稱被轉換為小寫(以避免大小寫不敏感的文件係統上的大小寫衝突)，最後轉換後的名稱通過以下方式變得唯一make.unique(sep = "_")。可以對代碼和幫助文件執行此操作，但不能對數據文件(按名稱查找)執行此操作。此外，代碼和幫助文件的名稱應以 ASCII 字母或數字開頭，並在必要時進行檢查z前置。

名稱以點開頭的函數放置在文件‘右/名字-內部.R’。

完成後，刪除‘Read-and-delete-我’文件，因為它不應該被分發。

值

用於side-effects。

例子

require(stats)
## two functions and two "data sets" :
f <- function(x, y) x+y
g <- function(x, y) x-y
d <- data.frame(a = 1, b = 2)
e <- rnorm(1000)

package.skeleton(list = c("f","g","d","e"), name = "mypkg")

參考

Read the ‘Writing R Extensions’ manual for more details.

Once you have created a source package you need to install it: see the ‘R Installation and Administration’ manual, INSTALL and install.packages.

也可以看看

prompt、promptClass 和 promptMethods。

package_native_routine_registration_skeleton 用於幫助準備帶有編譯代碼的包。