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 用于帮助准备带有编译代码的包。