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

loveR

PileupFiles(Rsamtools)
PileupFiles()所属R语言包：Rsamtools

                                        Represent BAM files for pileup summaries.
                                         代表的BAM堆积摘要文件。

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

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

Use PileupFiles() to create a reference to a BAM files (and their indicies), to be used for calculating pile-up summaries.
使用PileupFiles()创建一个BAM文件（其序号为）的参考，可用于计算桩摘要。


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



## Constructors
PileupFiles(files, ..., param=PileupParam())
## S4 method for signature 'character'
PileupFiles(files, ..., param=PileupParam())
## S4 method for signature 'list'
PileupFiles(files, ..., param=PileupParam())

## opening / closing
## S3 method for class 'PileupFiles'
open(con, ...)
## S3 method for class 'PileupFiles'
close(con, ...)

## accessors; also path()
## S4 method for signature 'PileupFiles'
isOpen(con, rw="")
plpFiles(object)
plpParam(object)

## actions
## S4 method for signature 'PileupFiles,missing'
applyPileups(files, FUN, ..., param)
## S4 method for signature 'PileupFiles,PileupParam'
applyPileups(files, FUN, ..., param)

## display
## S4 method for signature 'PileupFiles'
show(object)




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

参数：files
For PileupFiles, a character() or list of BamFile instances representing files to be included in the pileup. Using a list of BamFile allows indicies to be specified when these are in non-standard format. All elements of ... must be the same type.  For applyPileups,PileupFiles-method, a PileupFiles instance.
PileupFiles，character()或listBamFile实例代表在堆积中包含的文件。使用list“BamFile可以指定序号为这些非标准格式。 ...所有元素必须是同一类型。 applyPileups,PileupFiles-method，PileupFiles实例。


参数：...
Additional arguments, currently ignored.
额外的参数，目前被忽略。


参数：con, object
An instance of PileupFiles.
PileupFiles实例。


参数：FUN
A function of one argument; see applyPileups.
一个一个参数的函数;看到applyPileups。


参数：param
An instance of PileupParam,  to select which records to include in the pileup, and which summary information to return.
一个实例PileupParam，选择包括在堆积的记录，并返回的摘要信息。


参数：rw
character() indicating mode of file; not used for TabixFile.
说明文件模式字符（）;不使用TabixFile。


类的对象----------Objects from the Class----------

Objects are created by calls of the form PileupFiles().
对象的创建形式PileupFiles()检测。


领域----------Fields----------

The PileupFiles class is implemented as an S4 reference class. It has the following fields:
PileupFiles类实施S4引用类的。它具有以下领域：




files A list of BamFile instances.
BamFile实例的文件列表。




param An instance of PileupParam.
参数PileupParam的实例。


函数和方法----------Functions and methods----------

Opening / closing:
打开/关闭：




open.PileupFiles Opens the (local or remote) path and index of each file in the PileupFiles
open.PileupFiles打开（本地或远程）path和index每个文件在PileupFiles




close.PileupFiles Closes each file in the PileupFiles instance; returning (invisibly) the updated PileupFiles. The instance may be re-opened with
close.PileupFiles关闭PileupFiles实例中的每个文件;返回（不可见）的更新PileupFiles。实例可能会重新开

Accessors:
存取：




plpFiles Returns the list of the files in the
plpFiles返回在文件list




plpParam Returns the PileupParam content of the
plpParam返回PileupParam内容

Methods:
方法：




applyPileups Calculate the pileup across all files in files according to criteria in param (or plpParam(files) if param is missing), invoking FUN on each range or collection of positions. See
applyPileups计算堆积在所有文件中的filesparam（或plpParam(files)如果param丢失），调用FUN收集每个范围或标准职位。见




show Compactly display the object.
显示紧显示对象。


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


Martin Morgan



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


example(applyPileups)

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


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