R语言 TRAMPR包 update.TRAMP()函数中文帮助文档(中英文对照)

loveR

update.TRAMP(TRAMPR)
update.TRAMP()所属R语言包：TRAMPR

                                        Interactively Alter a TRAMP Object
                                         以交互方式改变一个流浪汉对象

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

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

This function allows some manual checking and correction of a TRAMP object.  By default, it steps through each sample, and offers to (1) add a new known to the TRAMPknowns database within the TRAMP object (see add.known for details), (2) mark matches to be ignored in future calls to plot.TRAMP (see remove.TRAMP.match), (3) save the current plot as a PDF.
此功能允许一些手工检查和纠正的TRAMP对象。默认情况下，它的步骤，通过每个样品，并提供：（1）添加一个新的TRAMPknowns数据库内TRAMP对象（见add.known），（2）标记比赛被忽略plot.TRAMP（参见remove.TRAMP.match），（3）保存当前绘图为PDF在将来调用。


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


## S3 method for class 'TRAMP'
update(object, sample.fk=labels(object$samples), grouped=FALSE,
       ignore=TRUE, delay.rebuild=FALSE, default.species=NULL,
       filename.fmt="TRAMP_%d.pdf", ...)



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

参数：object
A TRAMP object.
ATRAMP对象。


参数：sample.fk
A vector of sample.fk to cycle through.  If omitted, this will default to all samples present in the TRAMPsamples component of the TRAMP object.
sample.fk循环的矢量。如果省略，这将默认为所有样品在TRAMPsamples组成部分TRAMP对象。


参数：grouped, ignore
Plotting parameters, as in plot.TRAMP.  Currently these cannot be altered from their default values.
绘图参数，如plot.TRAMP。目前，这些不应该改变他们的默认值。


参数：delay.rebuild
Logical: Should the rebuild of the TRAMP object be delayed until the function returns?  If this is FALSE (the default), then the TRAMP object will rebuild every time a new known is added.  This may take a while for large objects, so if set to TRUE, then the TRAMP object will not be rebuilt until all sample.fks have been displayed.  This means that any new samples added as knowns will not be included in plots.
逻辑：如果重建TRAMP对象被延迟，直到该函数返回？如果这是FALSE（默认值），然后TRAMP对象将重建每次添加一个新的已知。的物体大，这可能需要一段时间，所以如果设置为TRUE，然后不会被重建TRAMP对象，直到所有的sample.fkS已显示。这意味着，任何新增加一条，作为已知的样本，将不包括在图。


参数：default.species
Default species name for newly added knowns. Passed to add.known.
默认为新增加的已知物种名称。传递到add.known。


参数：filename.fmt
Format used to generate filenames when saving PDFs.  Include a "%d" to stand in for the sample.fk (so "TRAMP_%d.pdf" becomes "TRAMP_12.pdf" for sample.fk 12).
使用的格式保存PDF时，生成的文件名。包含一个"%d"（所以站在sample.fk "TRAMP_%d.pdf""TRAMP_12.pdf"sample.fk12）。


参数：...
Further arguments passed to the plotting function plot.TRAMP.
进一步的参数传递给绘图功能plot.TRAMP。


警告----------Warning----------

If an error occurs while running update, all modifications will be lost.
如果发生错误运行update时，所有的修改将丢失。


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

update.TRAMP returns a modified TRAMP object, and does not modify the original TRAMP object in place.  You must use it like:
update.TRAMP返回修改TRAMP对象，并不会修改原始的TRAMP对象的地方。您必须使用它，如：

x <- update(x)
x <- update(x)

or
或

x2 <- update(x)
x2 <- update(x)

to modify the original object or create a new, modified object in place.  Note that if creating mutiple objects, if the TRAMPknowns object has a file.pat element, then any changes to either of x or x2 will be written back to file, but the knowns contained in x and x2 may be different.  See the note in add.known.
修改原来的对象，或创建一个新的地方，修改的对象。请注意，如果要创建多发对象，如果TRAMPknowns对象有一个file.pat元素，那么无论是x或x2会被写回文件，但任何更改已知在x和x2可能是不同的。见附注在add.known。

The action &ldquo;Quit&rdquo; will always exit the update function and save the object.
行动“退出”将永远退出update功能并保存该对象。

Be careful when using a TRAMP object whose TRAMPknowns element has a file.pat element; new knowns added will be immediately written to file.
使用时要小心TRAMP对象，其TRAMPknowns元素有一个file.pat元素，新的已知将被立即写入到文件中。


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


## Since this function runs interactively, there can be no sample.[＃由于此功能以交互方式运行，但不能样品。]

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


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