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

loveR

agiFromBam(girafe)
agiFromBam()所属R语言包：girafe

                                         Create AlignedGenomeIntervals objects from BAM files.
                                         创建AlignedGenomeIntervals对象的BAM文件。

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

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

Function to create AlignedGenomeIntervals objects from BAM (binary alignment map format) files. Uses functions from package Rsamtools to parse BAM files.
函数来创建AlignedGenomeIntervals对象从BAM（二进制对准图格式）文件。使用包Rsamtools解析BAM文件的功能。


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


agiFromBam(bamfile, ...)



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

参数：bamfile
File path of BAM file. BAM file should be sorted and have an index in the same directory (see Details below).  
BAM的文件的文件路径。 BAM文件应该进行排序，并在同一目录索引（详见下文）。


参数：...
further arguments passed on to function scanBam  
通过进一步的论据运作scanBam


Details

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

Note: the BAM files must be sorted and must also have an index file (*.bai) in the same directory. These should be done when creating the BAM. However, the functions sortBam and indexBam can be used for the same purpose, as can the respective modules of the “samtools” library ("samtools sort" and "samtools index").
注：在BAM文件必须进行排序，还必须有一个索引文件（*.bai）在同一目录。这些应做的时候创造的BAM。然而，功能sortBam和indexBam可以使用同样的目的，“samtools库”（“samtools排序和samtools指数”）各自的模块。

The BAM files are parsed chromosome by chromosome to limit the memory footprint of the function. Thus, this function aims to be a less-memory-consuming alternative to first reading in the BAM file using the readAligned function and then converting the AlignedRead object into an AlignedGenomeIntervals object.
BAM的文件是由染色体解析染色体的功能，以限制内存占用。因此，此功能的目的是1减少内存耗费的替代使用readAligned函数，然后AlignedRead对象转换成AlignedGenomeIntervals对象，在BAM文件的一读。


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

An object of class AlignedGenomeIntervals.
对象类AlignedGenomeIntervals。


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


J Toedling



参考文献----------References----------



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

scanBam, AlignedGenomeIntervals-class
scanBam，AlignedGenomeIntervals-class


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


  fl <- system.file("extdata", "ex1.bam", package="Rsamtools")
  ExGi <- agiFromBam(fl)
  head(detail(ExGi))

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


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