nuget server logo nuget api documents
↑

API Docs / SMRUCC.genomics.Core / Taxonomy

Taxonomy

Full name SMRUCC.genomics.Metagenomics.Taxonomy Assembly SMRUCC.genomics.Core Members 18

A simple organism taxonomy model.

00 Remarks

主要是用来保存csv以及Xml文件使用

01 Syntax

SMRUCC.genomics.Metagenomics.Taxonomy

02 Methods

NameOverloadsSummary
.ctor 3 需要在这里使用无参的构造函数来提供按照属性赋值的初始化形式
Select 1 Convert current Taxonomy object as a string array.
CompareWith 1 这个函数不会比较Taxonomy.scientificName
ToString 2 返回BIOM格式的Taxonomy字符串

03 Properties

NameOverloadsSummary
kingdom 1 1. 界
phylum 1 2. 门
class 1 3A. 纲
order 1 4B. 目
family 1 5C. 科
genus 1 6D. 属
species 1 7E. 种
RankLevel 1 获取当前的这个分类结果值的最小分类单元的等级
ncbi_taxid 1
scientificName 1
Unclassified 1

04 Members

method .ctor overload 2 #
#ctor(Dictionary(Of String, String), String)

这个函数会自动调用BIOMTaxonomy.FillLineageEmpty()函数来填充缺失掉的rank部分 所以这个构造方法是安全的构造方法,不需要担心会因为缺少否些rank而抛出错误

Parameters
NameTypeDescription
lineageDictionary(Of String, String)

-

method .ctor overload 3 #
#ctor(IEnumerable(Of TaxonomyNode))

construct of the taxonomy information from the ncbi taxonomy tree lineage data

Parameters
NameTypeDescription
taxonomyNodesIEnumerable(Of TaxonomyNode)

-

method .ctor #
#ctor

需要在这里使用无参的构造函数来提供按照属性赋值的初始化形式

method Select #

Convert current Taxonomy object as a string array. (返回来的元素值是按照TaxonomyRanks从大到小排列的)

method CompareWith #
CompareWith(Taxonomy)

这个函数不会比较Taxonomy.scientificName

Parameters
NameTypeDescription
anotherTaxonomy

item b

method ToString #
ToString

返回BIOM格式的Taxonomy字符串

method ToString overload 2 #
ToString(Boolean, Boolean)

如果BIOMstyle参数为真,则返回符合BIOM文件要求的Taxonomy字符串格式

Parameters
NameTypeDescription
BIOMstyleBoolean

-

trimGenusBoolean

only works when BIOMstyle parameter value set to TRUE

property kingdom #
kingdom
  1. 界
property phylum #
phylum
  1. 门
property class #
class

3A. 纲

property order #
order

4B. 目

property family #
family

5C. 科

property genus #
genus

6D. 属

property species #
species

7E. 种

property RankLevel #
RankLevel

获取当前的这个分类结果值的最小分类单元的等级

property ncbi_taxid #
ncbi_taxid
property scientificName #
scientificName
property Unclassified #
Unclassified