AssemblyLevelClassifier

Full name SMRUCC.genomics.Assembly.NCBI.GenBank.GBFF.AssemblyLevelClassifier Assembly SMRUCC.genomics.Core Members 11

Helper module for determines that the target genbank record is a complete assembled chromosome genome data or not.

00 Remarks

(判断目标genbank数据对象是否为一个完整组装的染色体基因组数据，用于泛基因组分析的取样过滤)

01 Syntax

SMRUCC.genomics.Assembly.NCBI.GenBank.GBFF.AssemblyLevelClassifier

02 Methods

Name	Overloads	Summary
IsCompleteChromosome	1	判断目标genbank对象是否为一个完整组装的染色体基因组数据
GetAssemblyLevel	1	判断目标genbank对象所对应的基因组的组装水平
GetAssemblyLevelEvidence	1	判断目标genbank对象所对应的基因组的组装水平，同时返回本次判定所依据的证据
CountAssemblyGaps	1	统计目标genbank数据之中的 assembly_gap 特征的数量
StructuredValue	1	获取目标genbank记录之中的结构化注释字段的值
GetComment	1	获取目标genbank记录的COMMENT字段的文本内容
GetAccession	1	获取目标genbank记录的accession编号，用于WGS格式的正则匹配
GetHeaderText	1	拼接用于关键词匹配的头部文本：DEFINITION + KEYWORDS + /submitter_seqid + SOURCE
IsMatch	1	判断目标accession编号是否命中给定的WGS编号格式的正则列表

03 Fields

Name	Overloads	Summary
wgsMaster	1	WGS master accession: 4/6个字母前缀之后跟随一个0以及若干位数字，例如 AKBV00000000
wgsContig	1	WGS contig/scaffold accession: 4个字母前缀+8位数字，或者6个字母前缀+至少10位数字，例如 AKBV01000001

04 Members

method IsCompleteChromosome #

IsCompleteChromosome(File)

判断目标genbank对象是否为一个完整组装的染色体基因组数据

Remarks

(泛基因组分析一般只关注核基因组的主染色体，所以需要在这里排除掉质粒与细胞器基因组)

Parameters

Name	Type	Description
`gbk`	File	目标genbank数据库数据对象

Returns

只有当目标记录的分子类型为核基因组(GenomeMolType.Nuclear)，并且其组装水平为完整组装或者染色体级别的时候，才会返回True。质粒与细胞器基因组(线粒体/叶绿体等)一律返回False。

method GetAssemblyLevel #

GetAssemblyLevel(File)

判断目标genbank对象所对应的基因组的组装水平

Parameters

Name	Type	Description
`gbk`	File	目标genbank数据库数据对象

method GetAssemblyLevelEvidence #

GetAssemblyLevelEvidence(File)

判断目标genbank对象所对应的基因组的组装水平，同时返回本次判定所依据的证据

Parameters

Name	Type	Description
`gbk`	File	目标genbank数据库数据对象

method CountAssemblyGaps #

CountAssemblyGaps(File)

统计目标genbank数据之中的 assembly_gap 特征的数量

Parameters

Name	Type	Description
`gbk`	File	-

method StructuredValue #

StructuredValue(String, String)

获取目标genbank记录之中的结构化注释字段的值

Parameters

Name	Type	Description
`comment`	`String`	COMMENT字段的文本内容
`key`	`String`	结构化注释的字段名，例如 `Genome Representation`

Returns

假若不存在目标字段，则会返回空值

method GetComment #

GetComment(File)

获取目标genbank记录的COMMENT字段的文本内容

Parameters

Name	Type	Description
`gbk`	File	-

Returns

不存在COMMENT字段的时候会返回空字符串

method GetAccession #

GetAccession(File)

获取目标genbank记录的accession编号，用于WGS格式的正则匹配

Parameters

Name	Type	Description
`gbk`	File	-

method GetHeaderText #

GetHeaderText(File, Feature)

拼接用于关键词匹配的头部文本：DEFINITION + KEYWORDS + /submitter_seqid + SOURCE

Parameters

Name	Type	Description
`gbk`	File	-
`source`	Feature	目标genbank记录的source feature对象

method IsMatch #

IsMatch(String, Regex())

判断目标accession编号是否命中给定的WGS编号格式的正则列表

field wgsMaster #

wgsMaster

WGS master accession: 4/6个字母前缀之后跟随一个0以及若干位数字，例如 AKBV00000000

field wgsContig #

wgsContig

WGS contig/scaffold accession: 4个字母前缀+8位数字，或者6个字母前缀+至少10位数字，例如 AKBV01000001