找回密码
 注册
查看: 2573|回复: 0

R语言:package.skeleton()函数中文帮助文档(中英文对照)

[复制链接]
发表于 2012-2-16 19:53:07 | 显示全部楼层 |阅读模式
package.skeleton(utils)
package.skeleton()所属R语言包:utils

                                        Create a Skeleton for a New Source Package
                                         创建一个新的源包骨架

                                         译者:生物统计家园网 机器人LoveR

描述----------Description----------

package.skeleton automates some of the setup for a new source package.  It creates directories, saves functions, data, and R code files to appropriate places, and creates skeleton help files and a "Read-and-delete-me" file describing further steps in packaging.
package.skeleton自动化的一个新的源码包的一些设置。它创建目录,以适当的地方保存功能,数据和R代码文件,并创建骨架的帮助文件和“Read-and-delete-me文件描述包装的进一步步骤。


用法----------Usage----------


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



参数----------Arguments----------

参数:name
character string: the package name and directory name for your package.
字符串:你的包的包的名称和目录名。


参数:list
character vector naming the R objects to put in the package.  Usually, at most one of list, environment, or code_files will be supplied.  See "Details".
特征向量命名R对象,把包中的。通常情况下,将提供最list,environment或code_files。见“详细资料”。


参数:environment
an environment where objects are looked for.  See "Details".
寻找对象的环境。见“详细资料”。


参数:path
path to put the package directory in.
路径把包目录中。


参数:force
If FALSE will not overwrite an existing directory.
如果FALSE不会覆盖现有的目录。


参数:namespace
a logical, no longer used, and hence deprecated.  A NAMESPACE file is always created to export all objects whose names begin with a letter, plus all S4 methods and classes.
一个逻辑,不再使用,因此不赞成。始终创建一个NAMESPACE文件导出的所有对象,其名称以字母,再加上所有中S4中的方法和类开始。


参数:code_files
a character vector with the paths to R code files to build the package around.  See "Details".
与R代码文件的路径周围建立包的特征向量。见“详细资料”。


Details

详情----------Details----------

The arguments list, environment, and code_files provide alternative ways to initialize the package.  If code_files is supplied, the files so named will be sourced to form the environment, then used to generate the package skeleton. Otherwise list defaults to the non-hidden files in environment (those whose name does not start with .), but can be supplied to select a subset of the objects in that environment.
的论点list,environment,code_files提供替代的方法来初始化包。如果code_files提供,如此命名的文件将源形成环境,然后用于生成包骨架。否则list默认的非隐藏文件environment(那些名不启动.),但可提供的选择,在这种环境中的对象的一个子集。

Stubs of help files are generated for functions, data objects, and S4 classes and methods, using the prompt, promptClass,  and promptMethods functions.
帮助文件生成存根,功能,数据对象和S4类和方法,使用prompt,promptClass,promptMethods功能。

The package sources are placed in subdirectory name of path.  If code_files is supplied, these files are copied; otherwise, objects will be dumped into individual source files. The file names in code_files should  have suffix ".R" and be in the current working directory.
包源被放置在子目录namepath。如果code_files提供,这些文件将被复制;否则,对象将被倾倒到单个源文件。 code_files的文件名应该有后缀".R"“在当前工作目录。

The filenames created for source and documentation try to be valid for all OSes known to run R.  Invalid characters are replaced by _, invalid names are preceded by zz, names are converted to lower case (to avoid case collisions on case-insensitive file systems) and finally the converted names are made unique by make.unique(sep = "_").  This can be done for code and help files but not data files (which are looked for by name). Also, the code and help files should have names starting with an ASCII letter or digit, and this is checked and if necessary z prepended.
源代码和文档创建的文件名尝试是有效的运行无效字符河已知的所有操作系统都换成_,无效的名称冠以zz,名称转换为小写(以避免不区分大小写的文件系统的情况下碰撞),最后转换的名称由make.unique(sep = "_")独特。这是可以做到的代码和帮助文件,但没有数据文件(查找名称)。此外,代码和帮助文件的名字开始与ASCII字母或数字,这是检查,如有必要z前面。

When you are done, delete the "Read-and-delete-me" file, as it should not be distributed.
当你完成后,删除“Read-and-delete-me文件,它不应该被分发。


值----------Value----------

Used for its side-effects.
用于其副作用。


参考文献----------References----------


see the R Installation and Administration manual, <code>INSTALL</code> and <code>install.packages</code>.

参见----------See Also----------

prompt, promptClass, and promptMethods.
prompt,promptClass,promptMethods。


举例----------Examples----------


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")


转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。


注:
注1:为了方便大家学习,本文档为生物统计家园网机器人LoveR翻译而成,仅供个人R语言学习参考使用,生物统计家园保留版权。
注2:由于是机器人自动翻译,难免有不准确之处,使用时仔细对照中、英文内容进行反复理解,可以帮助R语言的学习。
注3:如遇到不准确之处,请在本贴的后面进行回帖,我们会逐渐进行修订。
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 注册

本版积分规则

手机版|小黑屋|生物统计家园 网站价格

GMT+8, 2025-1-24 21:21 , Processed in 0.023372 second(s), 15 queries .

Powered by Discuz! X3.5

© 2001-2024 Discuz! Team.

快速回复 返回顶部 返回列表