ScanBcfParam-class(Rsamtools)
ScanBcfParam-class()所属R语言包:Rsamtools
Parameters for scanning VCF / BCF files
VCF的/ BCF文件的扫描参数
译者:生物统计家园网 机器人LoveR
描述----------Description----------
Use ScanBcfParam() to create a parameter object influencing the "INFO" and "GENO" fields parsed, and which recrods are imported from a BCF file. Use of which requires that a BCF index file (<filename>.bci) exists.
使用ScanBcfParam()影响“信息”和“基因型”领域的解析,并recrods进口的BCF文件从创建一个参数对象。使用which需要,BCF索引文件(<filename>.bci)存在。
用法----------Usage----------
ScanBcfParam(info=character(), geno=character(), trimEmpty=TRUE,
which, ...)
## S4 method for signature 'missing'
ScanBcfParam(info=character(), geno=character(), trimEmpty=TRUE,
which, ...)
## S4 method for signature 'RangesList'
ScanBcfParam(info=character(), geno=character(), trimEmpty=TRUE,
which, ...)
## S4 method for signature 'RangedData'
ScanBcfParam(info=character(), geno=character(), trimEmpty=TRUE,
which, ...)
## S4 method for signature 'GRanges'
ScanBcfParam(info=character(), geno=character(), trimEmpty=TRUE,
which, ...)
ScanVcfParam(info=character(), geno=character(), trimEmpty=TRUE,
which, ...)
## Accessors
bcfInfo(object)
bcfGeno(object)
bcfTrimEmpty(object)
bcfWhich(object)
vcfInfo(object)
vcfGeno(object)
vcfTrimEmpty(object)
vcfWhich(object)
参数----------Arguments----------
参数:info
A character() vector of "INFO" fields (see scanVcfHeader) to be returned. Not currently implemented.
“信息”字段(见scanVcfHeader)要返回的字符()向量。目前尚未实现。
参数:geno
A character() vector of "GENO" fields (see scanVcfHeader) to be returned. character(0) returns all fields, NA_character_ returns none.
“基因型”字段(见scanVcfHeader)要返回的字符()向量。 character(0)返回的各个领域,NA_character_返回None。
参数:trimEmpty
A logical(1) indicating whether "GENO" fields with no values should be returned.
(1)表明“基因型”字段没有值是否应该返回一个逻辑。
参数:which
An object, for which a method is defined (see usage, above), describing the sequences and ranges to be queried. Variants whose POS lies in the interval(s) [start, end) are returned. Methods defined for ScanBcfParam are available for ScanVcfParam.
一个对象,方法定义(见用法,以上),要查询的序列和范围。变种的POS在于间隔(S)[start, end)返回。 ScanBcfParam定义的方法是可用ScanVcfParam。
参数:object
An instance of class ScanBcfParam.
实例类ScanBcfParam。
参数:...
Arguments used internally.
参数内部使用。
类的对象----------Objects from the Class----------
Objects can be created by calls of the form ScanBcfParam().
创建对象可以通过检测的形式ScanBcfParam()。
插槽----------Slots----------
which: Object of class "RangesList" indicating
which:Object类的"RangesList"说明
info: Object of class "character" indicating
info:Object类的"character"说明
geno: Object of class "character" indicating
geno:Object类的"character"说明
trimEmpty: Object of class "logical" indicating
trimEmpty:Object类的"logical"说明
functionas和方法----------Functionas and methods----------
See 'Usage' for details on invocation.
在调用的详细信息,请参阅“用法”。
Constructor:
构造:
ScanVcfParam, ScanBcfParam: Returns a ScanVcfParam or ScanBcfParam object. The which argument to the
ScanVcfParam,ScanBcfParam:返回一个ScanVcfParam或ScanBcfParam对象。 which参数
Accessors:
存取:
bcfInfo, bcfGeno, bcfTrimEmpty, bcfWhich: Return the
返回bcfInfo bcfGeno,bcfTrimEmpty,bcfWhich:
Methods:
方法:
show Compactly display the object.
显示紧显示对象。
作者(S)----------Author(s)----------
Martin Morgan <a href="mtmorgan@fhcrc.org">mtmorgan@fhcrc.org</a>
参见----------See Also----------
scanVcf
scanVcf
举例----------Examples----------
p0 <- ScanVcfParam()
## subset of reads based on genomic coordinates[#读取的子集基于基因组坐标]
which <- RangesList(seq1=IRanges(1000, 2000),
seq2=IRanges(c(100, 1000), c(1000, 2000)))
p1 <- ScanVcfParam(which=which)
## return only specified GENO field(s)[#返回唯一指定的基因型领域()]
p2 <- ScanVcfParam(geno="GT", which=which)
转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。
注:
注1:为了方便大家学习,本文档为生物统计家园网机器人LoveR翻译而成,仅供个人R语言学习参考使用,生物统计家园保留版权。
注2:由于是机器人自动翻译,难免有不准确之处,使用时仔细对照中、英文内容进行反复理解,可以帮助R语言的学习。
注3:如遇到不准确之处,请在本贴的后面进行回帖,我们会逐渐进行修订。
|