R语言 roxygen包 make.Rd.roclet()函数中文帮助文档(中英文对照)

loveR

make.Rd.roclet(roxygen)
make.Rd.roclet()所属R语言包：roxygen

                                        Make an Rd roclet which parses the given files and, if specified, populates...
                                         解析给定的文件，如果指定的话，填充，使的路roclet的...

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

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

Make an Rd roclet which parses the given files and, if specified, populates the given subdirectory with Rd files; or writes to standard out.  See <CITE>Writing R Extensions</CITE>
解析给定的文件，如果指定的话，填充号文件的子目录或写入到标准输出，使的路roclet的。请参阅<CITE>写R扩展</ CITE>


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


make.Rd.roclet(subdir, verbose=TRUE)



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

参数：subdir
directory into which to place the Rd files; if NULL, standard out.
到其中的目录放置号文件;如果NULL，标准输出。


参数：verbose
whether to declare what we're doing in the <VAR>subdir</VAR> </table>
是否要宣布我们在做什么，在对应的子目录</ VAR> </表>


Details

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

The first paragraph of a roxygen block constitutes its description, the subsequent paragraphs its details; moreover, the Rd roclet supports these tags:
，第一款的roxygen块构成其描述，以后各段的详细信息，此外，路roclet支持这些标签：

Roxygen tag
Roxygen标签

</td><td align="left"> Rd analogue
</ TD> <TD ALIGN="LEFT">路模拟

@author
@author

</td><td align="left"> \author
</ TD> <TD ALIGN="LEFT"> \author

@aliases
@aliases

</td><td align="left"> \alias, ...
</ TD> <TD ALIGN="LEFT"> \alias, ...

@concept
@concept

</td><td align="left"> \concept
</ TD> <TD ALIGN="LEFT"> \concept

@example
@example

</td><td align="left"> n/a
</ TD> <TD ALIGN="LEFT"> N /一

@examples
@examples

</td><td align="left"> \examples
</ TD> <TD ALIGN="LEFT"> \examples

@format
@format

</td><td align="left"> \format
</ TD> <TD ALIGN="LEFT"> \format

@keywords
@keywords

</td><td align="left"> \keyword, ...
</ TD> <TD ALIGN="LEFT"> \keyword, ...

@method
@method

</td><td align="left"> \method
</ TD> <TD ALIGN="LEFT"> \method

@name
@name

</td><td align="left"> \name
</ TD> <TD ALIGN="LEFT"> \name

@note
@note

</td><td align="left"> \note
</ TD> <TD ALIGN="LEFT"> \note

@param
@param

</td><td align="left"> \arguments{\item, ...}
</ TD> <TD ALIGN="LEFT"> \arguments{\item, ...}

@references
@references

</td><td align="left"> \references
</ TD> <TD ALIGN="LEFT"> \references

@return
@return

</td><td align="left"> \value
</ TD> <TD ALIGN="LEFT"> \value

@seealso
@seealso

</td><td align="left"> \seealso
</ TD> <TD ALIGN="LEFT"> \seealso

@source
@source

</td><td align="left"> \source
</ TD> <TD ALIGN="LEFT"> \source

@title
@title

</td><td align="left"> \title
</ TD> <TD ALIGN="LEFT"> \title

@TODO
@TODO

</td><td align="left"> n/a
</ TD> <TD ALIGN="LEFT"> N /一

@usage
@usage

</td><td align="left"> \usage
</ TD> <TD ALIGN="LEFT"> \usage

@authorSee &ldquo;2.1.1 Documenting functions&rdquo; from <CITE>Writing R Extensions</CITE>.
@author请参阅“2.1.1记录功能”从<CITE>写作R附加</ CITE>。

@aliasesA default alias is plucked from the @name or assignee; otherwise, @alias a b ... translates to \alias{a}, \alias{b}, &amp;c. If you specify one alias, however, specify them all.
@aliases一个默认的别名采@name或受让人，否则，@alias a b ...转换为\alias{a}，\alias{b}＆C。如果你指定一个别名，但是，指定他们所有。

@conceptSee &ldquo;2.8 Indices&rdquo; from <CITE>Writing R Extensions</CITE>.
@concept请参阅“2.8指数”<CITE>写R扩展</ CITE>。

@exampleEach @example tag specifies an example file relative to the package head; if the file resides in "tests", for instance, it will be checked with R CMD check. The contents of the file will be concatenated under \examples{...}.
@example每个@example标签指定一个例子文件的包头，如果该文件驻留在tests，例如，将检查R CMD check 。该文件的内容将被连接下\examples{...}。

@examplesVerbatim examples; see &ldquo;2.1.1 Documenting functions&rdquo; from <CITE>Writing R Extensions</CITE>.
@examples逐字例子，请参阅“2.1.1记录功能”从<CITE>写作R附加</ CITE>。

@formatSee &ldquo;2.1.2 Documenting data sets&rdquo; from <CITE>Writing R Extensions</CITE>.
“@format请参见”2.1.2记录数据集“<CITE>写R扩展</ CITE>。

@keywords@keywords a b ... translates to \keyword{a}, \keyword{b}, &amp;c.
@keywords“@keywords a b ... \keyword{a}，\keyword{b}＆C。

@methodUse @method <generic> <class> to document S3 functions.
@method使用@method <generic> <class>记录S3功能。

@nameIn the absense of an explicit @name tag, the name of an assignment is plucked from the assignee.
@name由于缺少一个明确的@name标签，名称的分配拔毛的受让人。

@noteSee &ldquo;2.1.1 Documenting functions&rdquo; from <CITE>Writing R Extensions</CITE>.
@note请参阅“2.1.1记录功能”从<CITE>写作R附加</ CITE>。

@paramEach function variable should have a @param <variable> <description> specified.
@param每一个函数变量应该有一个@param <variable> <description>规定。

@referencesSee &ldquo;2.1.1 Documenting functions&rdquo; from <CITE>Writing R Extensions</CITE>.
@references请参阅“2.1.1记录功能”从<CITE>写作R附加</ CITE>。

@returnThe return value of the function, or NULL.
@return返回值的函数，或NULL。

@seealsoSee &ldquo;2.1.1 Documenting functions&rdquo; from <CITE>Writing R Extensions</CITE>.
@seealso请参阅“2.1.1记录功能”从<CITE>写作R附加</ CITE>。

@sourceSee &ldquo;2.1.2 Documenting data sets&rdquo; from <CITE>Writing R Extensions</CITE>.
“@source请参见”2.1.2记录数据集“<CITE>写R扩展</ CITE>。

@titleA default title is plucked from the first sentence of the description; that is, the first phrase ending with a period, question mark or newline. In the absence of a description, the title becomes the @name or assignee; lastly, it can be overridden with @title.
@title预设的标题是弹拨从第一句的描述，这是一个句号，问号或换行结束，前半句。在说明的情况下，标题变成了@name或受让人;最后，它可以覆盖@title。

@TODONote to developers to get off their asses.
@TODO注意开发下车的屁股。

@usageA default usage is construed from a function's formals, but can be overridden with @usage (e.g. in the case of multiple functions in one Rd unit).
@usage使用的默认解释函数的形参，但可以覆盖@usage（例如，在多重功能的情况下，在1号机组）。


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

Rd roclet
路roclet


TODO----------TODO----------

param method setClass setGeneric setMethod
param方法的setClass setGeneric使用setMethod


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


#'[“]
#' Here are the details (notice the preceding blank[“下面是详细信息（注意前面的空白]
#' line); the name, title, usage and alias will be[“线）的名称，所有权，使用和别名将]
#' automatically generated.[“自动生成。]
#'[“]
#' @param a a parameter[“@参数一个参数]
#' @return NULL[“返回NULL]
f <- function(a=1) NULL

#' S3 functions require a @method tag for[S3的功能需要一个@的方法标签]
#' the time being.[“时间。]
#'[“]
#' @method specialize foo[“@方法专门富]
#' @param f a generic foo[“@参数f一个通用的富]
#' @param ... ignored[“@参数...忽视]
#' @return The specialized foo[@返回的专门富]
specialize.foo <- function(f, ...)
actually.specialize(f)

roclet <- make.Rd.roclet('man')

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


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