nuget server logo nuget api documents
↑

API Docs / SMRUCC.genomics.Core / MolTypeClassifier

MolTypeClassifier

Full name SMRUCC.genomics.Assembly.NCBI.GenBank.GBFF.MolTypeClassifier Assembly SMRUCC.genomics.Core Members 14

A helper module for determines the molecule type of the target genbank record.

00 Remarks

(依据NCBI genbank数据的source feature的限定符以及头部的DEFINITION/KEYWORDS字段, 判断目标基因组数据是属于核基因组,质粒,细胞器基因组还是病毒基因组)

01 Syntax

SMRUCC.genomics.Assembly.NCBI.GenBank.GBFF.MolTypeClassifier

02 Methods

NameOverloadsSummary
GetMolType 1 判断目标genbank对象所描述的分子的类型
GetMolTypeEvidence 1 判断目标genbank对象所描述的分子的类型,同时返回本次判定所依据的证据
IsPlasmidSource 1 目标genbank数据是否为质粒基因组
IsOrganelleSource 1 目标genbank数据是否为细胞器基因组(线粒体/质体/其他细胞器)
IsNuclearSource 1 目标genbank数据是否为核基因组
GetSourceFeature 1 获取目标genbank数据之中的source feature对象
GetHeaderText 1 拼接用于关键词兜底匹配的头部文本:DEFINITION + KEYWORDS + organism/SOURCE
MatchAny 1 在目标文本之中不区分大小写的匹配给定的关键词列表之中的任意一个关键词

03 Fields

NameOverloadsSummary
mitochondria 1 线粒体相关的受控词表与关键词
plastid 1 质体相关的受控词表与关键词
plasmidKeys 1 质粒关键词
virus 1 病毒相关的关键词
chromosomeKeys 1 染色体关键词
genomeKeys 1 基因组关键词(兜底)

04 Members

method GetMolType #
GetMolType(File)

判断目标genbank对象所描述的分子的类型

Parameters
NameTypeDescription
gbkFile

目标genbank数据库数据对象

Returns

返回一个GenomeMolType枚举值,用于指示目标genbank数据的分子类型

method GetMolTypeEvidence #
GetMolTypeEvidence(File)

判断目标genbank对象所描述的分子的类型,同时返回本次判定所依据的证据

Parameters
NameTypeDescription
gbkFile

目标genbank数据库数据对象

Returns

除了分子类型之外,还会返回本次判定所命中的限定符或者关键词,便于排查误判

method IsPlasmidSource #
IsPlasmidSource(File)

目标genbank数据是否为质粒基因组

Parameters
NameTypeDescription
gbkFile

目标genbank数据库数据对象

method IsOrganelleSource #
IsOrganelleSource(File)

目标genbank数据是否为细胞器基因组(线粒体/质体/其他细胞器)

Parameters
NameTypeDescription
gbkFile

目标genbank数据库数据对象

method IsNuclearSource #
IsNuclearSource(File)

目标genbank数据是否为核基因组

Parameters
NameTypeDescription
gbkFile

目标genbank数据库数据对象

method GetSourceFeature #
GetSourceFeature(File)

获取目标genbank数据之中的source feature对象

Remarks

这里不能够通过 FEATURES.source 属性来获取,因为该属性 直接取的是内部列表之中的第一个元素,当列表为空的时候会抛出下标越界的错误。

Parameters
NameTypeDescription
gbkFile

目标genbank数据库数据对象

Returns

假若目标genbank数据之中并不存在有source feature,则会返回空值

method GetHeaderText #
GetHeaderText(File, String)

拼接用于关键词兜底匹配的头部文本:DEFINITION + KEYWORDS + organism/SOURCE

Parameters
NameTypeDescription
gbkFile

-

organismString

source feature之中的/organism限定符的值

method MatchAny #
MatchAny(String, String())

在目标文本之中不区分大小写的匹配给定的关键词列表之中的任意一个关键词

Parameters
NameTypeDescription
textString

-

keywordsString()

-

Returns

返回第一个命中的关键词,假若全部都没有命中,则会返回空值

field mitochondria #
mitochondria

线粒体相关的受控词表与关键词

field plastid #
plastid

质体相关的受控词表与关键词

field plasmidKeys #
plasmidKeys

质粒关键词

field virus #
virus

病毒相关的关键词

field chromosomeKeys #
chromosomeKeys

染色体关键词

field genomeKeys #
genomeKeys

基因组关键词(兜底)