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

loveR

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

                                         Operations on indexed 'fasta' files.
                                         索引“FASTA”文件的操作。

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

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

Scan indexed fasta (or compressed fasta) files and their indicies.
扫描索引FASTA（或压缩FASTA）文件，其序号为。


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



indexFa(file, ...)
## S4 method for signature 'character'
indexFa(file, ...)

scanFaIndex(file, ...)
## S4 method for signature 'character'
scanFaIndex(file, ...)

countFa(file, ...)
## S4 method for signature 'character'
countFa(file, ...)

scanFa(file, param, ...)
## S4 method for signature 'character,GRanges'
scanFa(file, param, ...)
## S4 method for signature 'character,RangesList'
scanFa(file, param, ...)
## S4 method for signature 'character,RangedData'
scanFa(file, param, ...)
## S4 method for signature 'character,missing'
scanFa(file, param, ...)




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

参数：file
A character(1) vector containing the fasta file path.
一个字符（1）向量FASTA文件的路径。


参数：param
An optional GRanges, RangesList, or RangedData instance to select reads (and sub-sequences) for input.
一个可选的GRanges，RangesList或RangedData选择输入读取（子序列）的实例。


参数：...
Additional arguments, currently unused.
额外的参数，目前尚未使用。


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

indexFa visits the path in file and create an index file at the same location but with extension ".fai").
indexFafile访问路径，并创建一个索引文件，在相同的位置，但扩展。“辉”）。

scanFaIndex reads the sequence names and and widths of recorded in an indexed fasta file, returning the information as a GRanges object.
scanFaIndex读取序列名称和宽度的录索引FASTA文件中，返回GRanges对象的信息。

countFa returns the number of records in the fasta file.
countFa返回FASTA文件中的记录数量。

scanFa return the sequences indicated by param as a DNAStringSet instance. seqnames(param) selects the sequences to return; start(param) and end{param} define the (1-based) region of the sequence to return. Values of end(param) greater than the width of the sequence are set to the width of the sequence. When param is missing, all records are selected. When param is GRanges(), no records are selected.
scanFaparamDNAStringSet实例返回序列表示。 seqnames(param)选择返回的序列;start(param)和end{param}定义序列（1）区域返回。 end(param)比序列的宽度更大的值设置为序列的宽度。当param丢失，所有的记录都被选中。当param是GRanges()，没有记录被选中。


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



Martin Morgan <mtmorgan@fhcrc.org>.




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

<code>samtools</code>.

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


fa <- system.file("extdata", "ce2dict1.fa", package="Rsamtools")
countFa(fa)
(idx <- scanFaIndex(fa))
(dna <- scanFa(fa, idx[1:2]))
ranges(idx) &lt;- narrow(ranges(idx), -10)  # last 10 nucleotides[过去10个核苷酸]
(dna <- scanFa(fa, idx[1:2]))

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


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