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

loveR

getPkgVigList(DynDoc)
getPkgVigList()所属R语言包：DynDoc

                                        A function to retrieve a listing of package vignettes
                                         一个函数来检索一个包护身符上市

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

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

Functionality to retrive vignette metadata, on a per-vignette or a per-package level.
功能，以检索暗角元数据，对每一个暗角或每包级别。


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


getPkgVigList(pkg, vigDescFun=baseVigDesc, vigPath = "/doc/",
vigExt="\\.(Rnw|Snw|rnw|snw|Rtex)$", pkgVers = TRUE)

getVigInfo(vig,pkg=NULL, vigDescFun=baseVigDesc, pkgVers=TRUE)



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

参数：pkg
Path to a package directory
包目录的路径


参数：vig
Filename of a vignette
一个小品的文件名


参数：vigDescFun
Function to provide output string for display
功能，提供显示输出字符串


参数：vigPath
Path to directory that contains vignettes in the package
路径目录，其中包含在包的护身符


参数：vigExt
Regular expression pattern to match vignette file extensions
正则表达式模式匹配的小插曲的文件扩展名


参数：pkgVers
Record the package version with the other vignette metadata
与其他小插曲元数据记录软件包的版本


Details

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

getPkgVigList: This function will look at all vignette files in the directory <pkg>/<vigPath>.  It will then extract any header information (using getVigInfo), and return a list of this information.
getPkgVigList：此功能将在所有的小插曲文件目录<pkg>/<vigPath>。然后，它会提取任何头信息（使用getVigInfo），并返回此信息的列表。

getVigInfo:  This function will retrieve the metadata from a particular vignette file.  Any line starting with '%\Vignette' is taken to be metadata.  Common values include VignetteIndexEntry (required), VignetteKeywords, VignetteDepends, etc.  A named list of lists is returned to the user, where the names correspond to the particular metadata variable.
getVigInfo：此功能将检索从一个特定的小插曲文件的元数据。 ％\暗角开始的任何行采取的是元数据。共同的价值观，包括VignetteIndexEntry（），VignetteKeywords，VignetteDepends等命名的名单列表返回给用户，名称对应的特定元数据变量。

Both functions take a parameter baseVigDesc, which is a function to provide the output string to correspond with a vignette summary.  This function is directly called by getVigInfo.  It takes one parameter, which is a vigInfo list from getVigInfo.
这两个函数参数baseVigDesc，这是一个功能提供输出字符串对应一个插曲摘要。 getVigInfo直接调用此函数。它需要一个参数，这是一个从getVigInfovigInfo名单。


作者（S）----------Author(s)----------


Jeff Gentry



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

vignette
vignette


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


## Not run: [＃无法运行：]
   ## We need a vignette for this to work[＃我们需要为这个小插曲工作]
   dynPath <- system.file(package="DynDoc")
   vigList <- getPkgVigList(dynPath)
   vigList

## End(Not run)[＃结束（不运行）]

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


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