R语言:checkVignettes()函数中文帮助文档(中英文对照)

loveR

checkVignettes(tools)
checkVignettes()所属R语言包：tools

                                        Check Package Vignettes
                                         检查包小故事

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

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

Check all Sweave files of a package by running Sweave and/or Stangle on them. All R source code files found after the tangling step are sourceed to check whether all code can be executed without errors.
检查所有Sweave包文件，通过运行Sweave和/或Stangle他们。所有的R源代码中找到的文件后，纠缠步骤source版来检查所有的代码是否可以执行没有错误。


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


checkVignettes(package, dir, lib.loc = NULL,
               tangle = TRUE, weave = TRUE, latex = FALSE,
               workdir = c("tmp", "src", "cur"),
               keepfiles = FALSE)



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

参数：package
a character string naming an installed package.  If given, Sweave files are searched in subdirectory "doc".
一个字符串，命名已安装的软件包。如果给定，Sweave文件搜索子目录doc。


参数：dir
a character string specifying the path to a package's root source directory.  This subdirectory "inst/doc" is searched for Sweave files.
一个字符串，指定包的根源目录的路径。这个子目录inst/docSweave文件的搜索。


参数：lib.loc
a character vector of directory names of R libraries, or NULL.  The default value of NULL corresponds to all libraries currently known.  The specified library trees are used to search for package.
特征向量的研发图书馆的目录名，或NULL。默认值的NULL对应于目前已知的所有库。指定库树是用来搜索package。


参数：tangle
Perform a tangle and source the extracted code?
执行纠结source提取代码？


参数：weave
Perform a weave?
执行编织？


参数：latex
logical: if weave and latex are TRUE and there is no "Makefile" in the vignettes directory, run the weaved files through pdflatex.
逻辑：如果weave和latex是TRUE“有没有Makefile在护身符目录，运行pdflatex编织文件。


参数：workdir
Directory used as working directory while checking the vignettes. If "tmp" then a temporary directory is created, this is the default.  If "src" then the directory containing the vignettes itself is used, if "cur" then the current working directory of R is used.
目录作为工作目录，而检查的护身符。如果"tmp"然后创建一个临时目录，这是默认的。如果"src"然后包含护身符本身的目录，如果"cur"然后使用R的当前工作目录。


参数：keepfiles
Delete files in the temporary directory?  This option is ignored when workdir != "tmp".
删除临时目录中的文件？忽略此选项时，workdir != "tmp"。


Details

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

A "vignette" is a file in the package's "inst/doc" directory with extension ".Rnw" (preferred), ".Snw", ".Rtex" or ".Stex" (and lower-case versions are also accepted).
一个“小插曲”是一个文件包的inst/doc扩展.Rnw（首选），.Snw，<目录X>或.Rtex（小写版本也接受）。

If tangle is true, this function runs Stangle to produce (one or more) R code files from each vignette, then sources each code file in turn.
tangle如果是真实的，这个函数运行Stangle产生（一个或多个）从每个小插曲R代码文件，然后source的依次在每个代码文件。

If weave is true, the vignettes are run through Sweave, which will produce a ".tex" file for each vignette.  If latex is also true, texi2pdf is run on the ".tex" files from those vignettes which did not give errors in the previous steps.
weave如果是真实的，护身符是贯穿Sweave，这将产生一个.tex文件为每个暗角。 latex如果也是如此，texi2pdf上运行.tex护身符从这些文件没有给前面的步骤中的错误。


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

An object of class "checkVignettes", which is a list with the error messages found during the tangle, source, weave and latex steps. There is a print method for displaying the information contained in such objects.
一个类的对象"checkVignettes"，这是一个纠结，来源，编织和乳胶步骤期间发现的错误消息的列表。有print方法显示在这些对象中包含的信息。


注意----------Note----------

Prior to R 2.13.0 this was the code used by R CMD check, but the latter is now more careful, running the code for each vignette in a separate R session.
2.13.0&#341;之前，这是由R CMD check使用的代码，但后者现在更小心，运行代码为每一个单独的R会话的暗角。

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


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