nuget
The brief information of a genome.(基因组的摘要信息)
PTT
01 Syntax
SMRUCC.genomics.Assembly.NCBI.GenBank.TabularFormat.PTT
02 Methods
| Name | Overloads | Summary |
|---|---|---|
| GetObject | 1 | 查看某一个位点之上有哪些基因，假若需要查看某一个位点附近有哪些基因的话，则可以使用 PTT.GetRelatedGenes())方法进行查找 |
| GetGeneByName | 1 | Find gene by using genen name. |
| GetGeneByDescription | 1 | String fuzzy match on the gene product value |
| SaveXml | 1 | Save this ptt document as an xml document.(保存Ptt数据库为Xml文件) |
| Load | 1 | Load a ptt format text file, the ptt file is usually can be found at Ncbi FTP server for each species genome data. |
| ExistsLocusId | 1 | Does the target locus_tag exists in this genome brief data model. |
| TryGetGeneObjectValue | 1 | |
| GetStrandGene | 1 | Gets the strand specified genes. |
| TryGetGenesId | 1 | 由于GFF文件之中是按照GeneName来进行标识的，有些时候希望全部使用基因号进行标识，所以通过这个函数将基因名称统一转换为基因号 |
| GetRelatedGenes | 1 | 获取某一个位点在位置上有相关联系的基因 |
03 Properties
| Name | Overloads | Summary |
|---|---|---|
| GeneObjects | 1 | The gene brief information collection data in this genome.(这个基因组之中的所有的基因摘要数据) |
| Title | 1 | 基因组的标题 |
| Size | 1 | The genome original sequence length.(基因组序列的长度) |
| NumOfProducts | 1 | The number of gene product counts in this genome data: PTT.GeneObjects.Length .(当前的基因组数据之中的基因对象的数目) |
| GeneObject | 1 | 通过基因的Locus_Tag, GeneBrief.Synonym来获取某一个基因对象，不存在则返回空值 |
| GeneIDList | 1 | Gets a list of all of the gene object in this ptt document.(所有基因的基因号GeneBrief.Synonym列表) |
04 Fields
| Name | Overloads | Summary |
|---|---|---|
| __innerTable | 1 | {GeneBrief.Synonym, GeneBrief} |
05 Members
GetObject(
Int32, Boolean)查看某一个位点之上有哪些基因，假若需要查看某一个位点附近有哪些基因的话，则可以使用 PTT.GetRelatedGenes()方法进行查找
Parameters
| Name | Type | Description |
|---|---|---|
site | Int32 | 基因组序列之上的一个碱基位点 |
ComplementStrand | Boolean | 该目标基因是否位于互补链之上 |
GetGeneByName(
String)Find gene by using genen name.
Parameters
| Name | Type | Description |
|---|---|---|
Name | String | 基因名称，而非基因号 |
GetGeneByDescription(
Func(Of String, Boolean))String fuzzy match on the gene product value
Parameters
| Name | Type | Description |
|---|---|---|
matches | Func(Of String, Boolean) | - |
SaveXml(
String, Encoding)Save this ptt document as an xml document.(保存Ptt数据库为Xml文件)
Parameters
| Name | Type | Description |
|---|---|---|
Path | String | - |
encoding | Encoding | - |
Load(
String, Boolean)Load a ptt format text file, the ptt file is usually can be found at Ncbi FTP server for each species genome data.
Parameters
| Name | Type | Description |
|---|---|---|
path | String | Text file format ptt file path |
fillBlank | Boolean | Fill blank gene name. |
ExistsLocusId(
String)Does the target locus_tag exists in this genome brief data model. (通过基因的locus_tag, GeneBrief.Synonym来获取某一个基因对象是否存在)
Parameters
| Name | Type | Description |
|---|---|---|
locusId | String |
TryGetGeneObjectValue(
String, GeneBrief)Parameters
| Name | Type | Description |
|---|---|---|
GeneID | String | |
value | GeneBrief | - |
GetStrandGene(Strands)
Gets the strand specified genes.
Parameters
| Name | Type | Description |
|---|---|---|
strand | Strands | Strands.Forward/Strands.Reverse, Strands.Unknown will be treated as reversed. |
TryGetGenesId(
String)由于GFF文件之中是按照GeneName来进行标识的，有些时候希望全部使用基因号进行标识，所以通过这个函数将基因名称统一转换为基因号
Parameters
| Name | Type | Description |
|---|---|---|
tag | String | Tag data matches in fields: GeneBrief.Synonym, GeneBrief.Gene, GeneBrief.PID |
获取某一个位点在位置上有相关联系的基因
Parameters
| Name | Type | Description |
|---|---|---|
loci | NucleotideLocation | - |
unstrand | Boolean | - |
ATGDist | Int32 | - |
GeneObjects
The gene brief information collection data in this genome.(这个基因组之中的所有的基因摘要数据)
Title
基因组的标题
Size
The genome original sequence length.(基因组序列的长度)
NumOfProducts
The number of gene product counts in this genome data: PTT.GeneObjects.Length .(当前的基因组数据之中的基因对象的数目)
GeneObject(
String)通过基因的Locus_Tag, GeneBrief.Synonym来获取某一个基因对象，不存在则返回空值
Parameters
| Name | Type | Description |
|---|---|---|
locusId | String |
GeneIDList
Gets a list of all of the gene object in this ptt document.(所有基因的基因号GeneBrief.Synonym列表)
__innerTable