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

loveR

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

                                        Roclet: make Rd files.
                                         Roclet号文件。

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

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

This roclet is the workhorse of roxygen, producing the Rd files that document that functions in your package.
这roclet的主力roxygen号文件，该文件在你的包的功能。


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


  rd_roclet()



Details

详细信息----------Details----------

This roclet also automatically runs checkRd on all generated Rd files so that you know as early as possible if there's a problem.
这roclet还可以自动运行checkRd产生的所有号文件，让你知道，如果有一个问题尽早。


所需的标签----------Required tags----------

As well as a title and description, extracted from the first sentence and first paragraph respectively, all functions must have the following tags:
作为标题和描述，提取的第一句话和第一款，所有功能都必须具备下列标签：




@param name description Document a parameter.  Documentation is required for every
@param name description文件的一个参数。文档需要为每

source_function</dt> Alternatively, you can inherit parameter description from another function. This tag will bring in all documentation for parameters that are undocumented in the current function, but documented in the source function. The source can be a function in the current package, function, or another package
source_function </> </ dt的>或者，你可以继承另一个函数的参数说明。在当前的功能是无证的参数，这个标记将带来的所有文件，但文件中的源功能。源可以是一个函数，在当前包中，function，或其他程序包




@method generic class Required if your function is an S3 method.  This helps R to distinguish between (e.g.) t.test and the t method for
@method generic class如果你的函数是S3的方法。这有助于R来区分（例如）t.test和t方法


可选的标签，添加额外的信息----------Optional tags that add extra information----------

Valid tags for rd_roclet are:
有效的标签为rd_roclet：




@examples R code... Highly recommended: example code that demonstrates how to use your function. Use \dontrun to tag code that should not automatically
@examples R code...强烈推荐：示例代码，演示了如何使用功能。使用\ dontrun到标记代码，不应自动

path/relative/to/packge/root</dt> Instead of including examples directly in the documentation, you can include them as separate files, and use the @example tag
路径/亲戚/ /装箱率/根</ P> </ dt的>，而不是直接在文档中的例子，你可以包括它们作为单独的文件，并使用@example标签




@return Used to document the object returned by the function. For lists, use the \item{name a}{description a} describe each
@return用于记录由该函数返回的对象。对于列表中，使用\item{name a}{description a}描述每个




@author authors... A free text string describing the authors of the function.  This is typically only necessary if the author is not the same as
@author authors...的自由文本字符串，描述了作者的功能。这通常是必要的，如果作者是不一样的




@note contents Create a note section
@note contents创建一个注释部分




@section Name: contents Use to add to an arbitrary section to the documentation. The name of the section will be the content before the first colon, and
@section Name: contents使用添加的文档的任意部分。节的名称将是第一个冒号之前的内容，




@keywords keyword1 keyword2 ... Keywords are optional, but if present, must be taken from the list in "file.path(R.home(), "doc/KEYWORDS")".  Use the internal keyword for functions that should not
@keywords keyword1 keyword2 ...关键词是可选的，但如果存在的话，必须采取从列表中file.path(R.home(), "doc/KEYWORDS")。使用internal关键字的功能不应该


可选的标签为交叉引用----------Optional tags for cross-referencing----------




@aliases space separated aliases Add additional aliases, through which the user can find the documentation with ?.  The topic name is always
@aliases space separated aliases添加额外的别名，用户可以通过它找到的文件与?。主题名是永远




@concepts space separated concepts Similar
@concepts space separated concepts类似




@references free text reference Pointers to
@references free text reference指针

\code{\link{function}}</dt> Pointers to related R objects,
\代码\ {功能}} </ P> </ DT>指针相关的研究对象，




@family family name Automatically adds see-also cross-references between all functions in a
@family family name自动添加看到，也之间的交叉引用的所有功能于一身的


模板标签----------Template tags----------

Templates make it possible to substantially reduce documentation duplication. A template is an "R" file processed with brew and then inserted into the roxygen block. Templates can use variables, accessible from within brew with <=% varname =>.
模板，就可以基本上减少文件重复。模板是一个R的文件处理，brew，然后插入到roxygen块的。模板可以使用变量，内酿造<=% varname =>。

Templates are not parsed recursively, so you can not include templates from within other templates.
模板不递归解析，这样你就可以不包括在其他模板的模板。

Templates must be composed of complete tags - becuase all roxygen tags are current block tags, they can not be used for inline insertions.
模板必须由完整的标签 -  becuase所有roxygen标签是当前块的标签，他们不能被用于内嵌插入。




@template templateName Insert named
@template templateName插入指定




@templateVar varname value Set up variables
@templateVar varname value设置变量


覆盖默认值的可选标签----------Optional tags that override defaults----------

These tags all override the default values that roxygen guess from inspecting the source code.
这些标签覆盖默认值，roxygen想从检查的源代码。




@rdname filename Overrides the output file name (without extension). This is useful if your function has a name that is not a valid filename (e.g. [[<-), or you want to merge documentation for
@rdname filename覆盖输出文件名（不带扩展名）。这是非常有用的，如果你的函数都有一个名字，是不是一个有效的文件名（例如[[<-），或您要合并的文件




@title Topic title Specify the topic title, which by by default is taken from the first sentence of
@title Topic title指定主题标题，默认情况下，从第一句




@usage usage_string Override the default usage string.  You should not need to use this tag - if you are trying to document multiple functions in the same
@usage usage_string覆盖默认情况下使用的字符串。你不应该需要使用这个标签 - 如果你正试图在同一文件多重功能


非功能的标签----------Tags for non-functions----------

These tags are useful when documenting things that aren't functions, datasets and packages.
这些标签是有用的，当记录功能，数据集和包东西，是不是。




@name topicname Override the default topic name, which is taken by default from the object that is assigned to in the code immediately following the roxygen block. This tag is useful when documenting datasets, and
@name topicname覆盖的对象被分配到的代码紧随roxygen块，默认情况下，这是采取的默认主题名称。这个标签是有用的，当记录数据集，




@docType type Type of object being documented. Useful values are data and package. Package doc type will automatically add a
@docType type的对象的类型被记录在案。有用的值是data和package。包装doc文件会自动添加一个




@format description A textual description
@format description的文字说明




@source text The original source of the
@source text的原始来源


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

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


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


roclet <- rd_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：如遇到不准确之处，请在本贴的后面进行回帖，我们会逐渐进行修订。