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

loveR

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

                                        Roclet: make NAMESPACE.
                                         Roclet：NAMESPACE。

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

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

This roclet automates the production of a "NAMESPACE" file, see <CITE>Writing R Extensions</CITE> (http://cran.r-project.org/doc/manuals/R-exts.pdf) for details.
这roclet自动化生产的NAMESPACE文件，<CITE>写R扩展</ CITE>（http://cran.r-project.org/doc/manuals/R-exts。 PDF）的详细信息。


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


  namespace_roclet()



标签----------Tags----------

There are four tags for exporting objects from the package:
为出口对象从包中有四个标签：




@export Roxygen guesses the directive: export for functions, exportMethod for S4 methods, S3method for S3 methods, exportClass for S4 classes.
@export的Roxygen的猜测指令：export功能，exportMethodS4方法，S3methodS3方法，exportClassS4类。

This is the only directive you should need for documented function, the other directives are useful if you want to
你需要记录的功能，这是唯一的指令，其他指令都是有用的，如果你想




@export f g ... overrides auto-detection and produces multiple export directives:
@export f g ...覆盖自动检测和生成多个出口指令：




@exportClass x produces
@exportClass x产生




@exportMethod x produces
@exportMethod x产生




@S3method generic class produces
@S3method generic class产生

There are five tags for importing objects into the package:
进口对象放入包中有5个标签：




@import package produces import(package) directive to import all functions
@import package<CODE>生产，进口（包）指令导入的所有功能

...</dt> produces multiple importFrom(package,   function) directives to import selected functions from a
... </ P> </ dt的多个importFrom(package,   function)指令来导入功能从

...</dt> produces multiple importClassesFrom(package,   class) directives to import selected classes from a
... </ P> </ DT>生成多个importClassesFrom(package,   class)指令从导入选择的类

...</dt> produces multiple importMethodsFrom(package,   method) directives to import selected methods from a
... </ P> </ dt的产生多个importMethodsFrom(package,   method)指令来导入所选择的方法从




@useDynLib package produces a useDynLib(package) directive to import all compiled routines from the shared objects in the
@useDynLib package生产useDynLib(package)指令从共享中的对象导入所有编译的例程

routineb</dt> produces multiple useDynLib(package,routine) directions to import
routineb </ P> </ DT>生成多个useDynLib(package,routine)进口方向

Only unique directives are saved to the "NAMESPACE" file, so you can repeat them as needed to maintain a close link between the functions where they are needed and the namespace file..
唯一的指令保存到NAMESPACE文件，这样你就可以重复，并在必要时保持密切联系，需要他们的地方之间的职能和命名空间的文件..


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

Other roclets: collate_roclet, rd_roclet
其他roclets：collate_roclet，rd_roclet


实例----------Examples----------


#' An example file, example.R, which imports[一个例子文件，example.R，其中进口]
#' packages foo and bar[“包foo和bar]
#' @import foo bar[的@ import foo的条形]
NULL

#' An exportable function[“输出的另一种功能]
#' @export[“@出口]
fun <- function() {}

roclet <- namespace_roclet()
## Not run: roc_proc(roclet, "example.R")[＃不运行：roc_proc（roclet中，“example.R”）]
## Not run: roc_out(roclet, "example.R", ".")[＃不运行：roc_out（roclet中，“example.R”，“。”）]

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


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