VCF2GTB

java.lang.Object
- edu.sysu.pmglab.easytools.Parallelizable
- - edu.sysu.pmglab.gbc.VCF2GTB

```
public class VCF2GTB
extends edu.sysu.pmglab.easytools.Parallelizable
```
Variant Call Format (VCF) 或类似格式转换为 Genotype Block Format (GTB) 格式提供了一组标准程序 API 方法, 用于快速构建 GTB 文件 (CCF-based)

字段概要

字段
限定符和类型字段和说明

static byte[] validVcfStartsWith
输入文件的有效第一行识别字段 (即数据行或标题行) 默认为
- 从类继承的字段 edu.sysu.pmglab.easytools.Parallelizable
  AVAILABLE_PROCESSORS, INIT_THREADS

字段
限定符和类型	字段和说明
`static byte[]`	`validVcfStartsWith` 输入文件的有效第一行识别字段 (即数据行或标题行) 默认为

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`VCF2GTB`	`addField(java.lang.String fieldName, edu.sysu.pmglab.ccf.FieldType fieldType)` 添加额外的字段
`VCF2GTB`	`addFields(java.util.Map<java.lang.String,edu.sysu.pmglab.ccf.FieldType> fields)` 添加额外的字段
`VCF2GTB`	`addGenotypeFilter(IGenotypeController genotypeQC)` 按照 VCF 记录的基因型格式进行过滤, 它对每一个样本都有效
`VCF2GTB`	`addMeta(edu.sysu.pmglab.container.ByteCode key, edu.sysu.pmglab.container.ByteCode value)` 从外部直接注入元信息
`VCF2GTB`	`addMeta(edu.sysu.pmglab.ccf.CCFMeta meta)` 从外部直接注入元信息
`VCF2GTB`	`addMeta(java.lang.String key, java.lang.String value)` 从外部直接注入元信息
`VCF2GTB`	`addValueConverter(java.util.function.BiConsumer<java.util.Map<java.lang.String,edu.sysu.pmglab.container.ByteCode>,Variant> function)` 添加字段转换器
`VCF2GTB`	`addVariantFilter(java.util.function.Function<Variant,java.lang.Boolean> filter)` 位点过滤器在数据填充进 Variant 之后, 进行完整的过滤
`VCF2GTB`	`addVariantListener(java.util.function.Consumer<Variant> variantListener)` 位点监听器在数据填充进 Variant 之后, 根据更复杂的列元之间的相互规则重新赋予数据或监听数值
`VCF2GTB`	`addVCFFieldFilter(java.lang.String VCFFieldName, java.util.function.Function<edu.sysu.pmglab.container.ByteCode,java.lang.Boolean> VCFFilter)` 按照 VCF 记录进行过滤, 它在一条记录读取之前执行过滤
`GTBManager`	`convert()` 文件转换
`VCF2GTB`	`disableFilter()` 禁用过滤器
`edu.sysu.pmglab.container.File`	`getOutputFile()` 获取输出文件路径
`VCF2GTB`	`liftOver(LiftOver liftOver)` 使用 chain 搜索树进行版本提升
`VCF2GTB`	`liftOver(RefGenomeVersion fromGenomeVersion, RefGenomeVersion toGenomeVersion)` 使用 chain 搜索树进行版本提升
`static VCF2GTB`	`of(java.io.File inputFile)` 构造器方法
`static VCF2GTB`	`of(java.io.File inputFile, java.io.File outputFile)` 构造器方法
`static VCF2GTB`	`of(java.lang.String inputFileName)` 构造器方法
`static VCF2GTB`	`of(java.lang.String inputFileName, java.io.File outputFile)` 构造器方法
`VCF2GTB`	`setGTBFormat(GTBFormat gtbFormat)` 设置 GTB 文件格式
`VCF2GTB`	`setOutputFile(java.io.File outputFile)` 设置输出文件
`VCF2GTB`	`setThreads(int nThreads)`
`VCF2GTB`	`storeGenotype(boolean storeGenotype)` 设置是否储存基因型字段
`VCF2GTB`	`storeOriginMeta(boolean storeOriginMeta)` 设置是否储存文件自带的 meta 信息
`java.lang.String`	`toString()`

从类继承的方法 edu.sysu.pmglab.easytools.Parallelizable
addThreads, getThreads, reduceThreads, verify

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - validVcfStartsWith
```
public static final byte[] validVcfStartsWith
```
    输入文件的有效第一行识别字段 (即数据行或标题行) 默认为
- 方法详细资料
  - of
```
public static VCF2GTB of(java.io.File inputFile)
                  throws java.io.IOException
```
    构造器方法
    
    参数:
    
    inputFile - 输入文件对象
    
    返回:
    
    转换器对象
    
    抛出:
    
    java.io.IOException - IO 异常
  - of
```
public static VCF2GTB of(java.lang.String inputFileName)
                  throws java.io.IOException
```
    构造器方法
    
    参数:
    
    inputFileName - 输入文件名
    
    返回:
    
    转换器对象
    
    抛出:
    
    java.io.IOException - IO 异常
  - of
```
public static VCF2GTB of(java.io.File inputFile,
                         java.io.File outputFile)
                  throws java.io.IOException
```
    构造器方法
    
    参数:
    
    inputFile - 输入文件对象
    
    outputFile - 输出文件对象
    
    返回:
    
    转换器对象
    
    抛出:
    
    java.io.IOException - IO 异常
  - of
```
public static VCF2GTB of(java.lang.String inputFileName,
                         java.io.File outputFile)
                  throws java.io.IOException
```
    构造器方法
    
    参数:
    
    inputFileName - 输入文件名
    
    outputFile - 输出文件名
    
    返回:
    
    转换器对象
    
    抛出:
    
    java.io.IOException - IO 异常
  - setOutputFile
```
public VCF2GTB setOutputFile(java.io.File outputFile)
```
    设置输出文件
    
    参数:
    
    outputFile - 输出文件
    
    返回:
    
    本类
  - setGTBFormat
```
public VCF2GTB setGTBFormat(GTBFormat gtbFormat)
```
    设置 GTB 文件格式
    
    参数:
    
    gtbFormat - GTB 文件格式
    
    返回:
    
    本类
  - addMeta
```
public VCF2GTB addMeta(java.lang.String key,
                       java.lang.String value)
```
    从外部直接注入元信息
    
    参数:
    
    key - 元信息键
    
    value - 元信息值
    
    返回:
    
    本类
  - addMeta
```
public VCF2GTB addMeta(edu.sysu.pmglab.container.ByteCode key,
                       edu.sysu.pmglab.container.ByteCode value)
```
    从外部直接注入元信息
    
    参数:
    
    key - 元信息键
    
    value - 元信息值
    
    返回:
    
    本类
  - addMeta
```
public VCF2GTB addMeta(edu.sysu.pmglab.ccf.CCFMeta meta)
```
    从外部直接注入元信息
    
    参数:
    
    meta - 元信息字段前缀树
    
    返回:
    
    本类
  - addValueConverter
```
public VCF2GTB addValueConverter(java.util.function.BiConsumer<java.util.Map<java.lang.String,edu.sysu.pmglab.container.ByteCode>,Variant> function)
```
    添加字段转换器
    
    参数:
    
    function - 字段转换函数, Entry 的 key 对应该字段的值, Record 则是当前行的记录细节
    
    返回:
    
    本类
  - addVCFFieldFilter
```
public VCF2GTB addVCFFieldFilter(java.lang.String VCFFieldName,
                                 java.util.function.Function<edu.sysu.pmglab.container.ByteCode,java.lang.Boolean> VCFFilter)
```
    按照 VCF 记录进行过滤, 它在一条记录读取之前执行过滤
    
    参数:
    
    VCFFieldName - VCF 文件中的列名
    
    VCFFilter - VCF 字段过滤器
    
    返回:
    
    本类
  - addGenotypeFilter
```
public VCF2GTB addGenotypeFilter(IGenotypeController genotypeQC)
```
    按照 VCF 记录的基因型格式进行过滤, 它对每一个样本都有效
    
    参数:
    
    genotypeQC - 基因型过滤器
    
    返回:
    
    本类
  - addVariantListener
```
public VCF2GTB addVariantListener(java.util.function.Consumer<Variant> variantListener)
```
    位点监听器在数据填充进 Variant 之后, 根据更复杂的列元之间的相互规则重新赋予数据或监听数值
    
    参数:
    
    variantListener - 记录映射器
    
    返回:
    
    本类
  - addVariantFilter
```
public VCF2GTB addVariantFilter(java.util.function.Function<Variant,java.lang.Boolean> filter)
```
    位点过滤器在数据填充进 Variant 之后, 进行完整的过滤
    
    参数:
    
    filter - 记录映射器
    
    返回:
    
    本类
  - disableFilter
```
public VCF2GTB disableFilter()
```
    禁用过滤器
    
    返回:
    
    本类
  - addField
```
public VCF2GTB addField(java.lang.String fieldName,
                        edu.sysu.pmglab.ccf.FieldType fieldType)
```
    添加额外的字段
    
    参数:
    
    fieldName - 字段名
    
    fieldType - 字段类型
    
    返回:
    
    本类
  - addFields
```
public VCF2GTB addFields(java.util.Map<java.lang.String,edu.sysu.pmglab.ccf.FieldType> fields)
```
    添加额外的字段
    
    参数:
    
    fields - 列名及其类型
    
    返回:
    
    本类
  - setThreads
```
public VCF2GTB setThreads(int nThreads)
```
    覆盖:
    
    setThreads 在类中 edu.sysu.pmglab.easytools.Parallelizable
  - storeOriginMeta
```
public VCF2GTB storeOriginMeta(boolean storeOriginMeta)
```
    设置是否储存文件自带的 meta 信息
    
    参数:
    
    storeOriginMeta - 是否储存 meta 信息
    
    返回:
    
    本类
  - storeGenotype
```
public VCF2GTB storeGenotype(boolean storeGenotype)
```
    设置是否储存基因型字段
    
    参数:
    
    storeGenotype - 是否储存基因型字段
    
    返回:
    
    本类
  - liftOver
```
public VCF2GTB liftOver(LiftOver liftOver)
```
    使用 chain 搜索树进行版本提升
    
    参数:
    
    liftOver - 链搜索树
    
    返回:
    
    本类
  - liftOver
```
public VCF2GTB liftOver(RefGenomeVersion fromGenomeVersion,
                        RefGenomeVersion toGenomeVersion)
                 throws java.io.IOException
```
    使用 chain 搜索树进行版本提升
    
    参数:
    
    fromGenomeVersion - 源参考基因组版本
    
    toGenomeVersion - 目标参考基因组版本
    
    返回:
    
    本类
    
    抛出:
    
    java.io.IOException - IO 异常
  - getOutputFile
```
public edu.sysu.pmglab.container.File getOutputFile()
```
    获取输出文件路径
    
    返回:
    
    输出文件路径
  - convert
```
public GTBManager convert()
                   throws java.io.IOException
```
    文件转换
    
    返回:
    
    构建的 GTB 文件对象
    
    抛出:
    
    java.io.IOException - 文件读取过程中产生的 IO 异常 (包括占用、指针异常、不存在等)
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object

类 VCF2GTB

字段概要

从类继承的字段 edu.sysu.pmglab.easytools.Parallelizable

方法概要

从类继承的方法 edu.sysu.pmglab.easytools.Parallelizable

从类继承的方法 java.lang.Object

字段详细资料

validVcfStartsWith

方法详细资料

of

of

of

of

setOutputFile

setGTBFormat

addMeta

addMeta

addMeta

addValueConverter

addVCFFieldFilter

addGenotypeFilter

addVariantListener

addVariantFilter

disableFilter

addField

addFields

setThreads

storeOriginMeta

storeGenotype

liftOver

liftOver

getOutputFile

convert

toString