R语言 roxygen2包 roxygenize()函数中文帮助文档(中英文对照)

loveR

roxygenize(roxygen2)
roxygenize()所属R语言包：roxygen2

                                        Process a package with the Rd, namespace and collate roclets.
                                         处理的的路命名空间和整理roclets的的包。

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

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

This is the workhorse function that uses roclets, the built-in document tranformation functions, to build all documentation for a package.  See the documentation for the individual roclets, rd_roclet, namespace_roclet and collate_roclet, for documentation on how to use each one.
这是主力功能，使用的roclets，内置的文件的魏宏功能，建立包的所有文件。请参阅相关文档的个人roclets的，rd_roclet，namespace_roclet和collate_roclet，如何使用每一个文件。


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


  roxygenize(package.dir, roxygen.dir = package.dir,
    copy.package = package.dir != roxygen.dir,
    overwrite = TRUE, unlink.target = FALSE,
    roclets = c("collate", "namespace", "rd"))

  roxygenise(package.dir, roxygen.dir = package.dir,
    copy.package = package.dir != roxygen.dir,
    overwrite = TRUE, unlink.target = FALSE,
    roclets = c("collate", "namespace", "rd"))



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

参数：package.dir
the package's top directory
包的目录


参数：roxygen.dir
where to create roxygen output; defaults to "package.dir".
在哪里创建roxygen输出，默认为package.dir。


参数：copy.package
copies the package over before adding/manipulating files.
前添加/操作文件复制的包。


参数：overwrite
overwrite target files?
覆盖目标文件吗？


参数：unlink.target
unlink target directory before processing files?
取消链接处理文件的目标目录，然后呢？


参数：roclets
character vector of roclet names to apply to package
字符向量的roclet名称适用于包


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

NULL
NULL

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


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