nuget server logo nuget api documents
↑

API Docs / SMRUCC.genomics.Core / File

File

Full name SMRUCC.genomics.Assembly.NCBI.GenBank.GBFF.File Assembly SMRUCC.genomics.Core Members 26

NCBI GenBank database file.

00 Remarks

The National Center for Biotechnology Information (NCBI) GenBank® database is a comprehensive, annotated collection of all publicly available nucleotide sequences and their protein translations. It is a key resource for bioinformatics researchers and scientists around the world. Here is an introduction to the GenBank database file:

What is GenBank?

Establishment: GenBank was established in 1982 and is maintained by the NCBI, which is part of the National Library of Medicine (NLM) at the National Institutes of Health (NIH) in the United States. Content: It contains sequences from various sources, including genomic, transcriptomic, and metagenomic studies, as well as sequences from viruses, prokaryotes, eukaryotes, and organelles. Purpose: The primary purpose of GenBank is to provide scientists with a reliable and freely accessible database to deposit and retrieve genetic sequence data. Key Components of a GenBank File: A GenBank file is typically composed of several sections, each containing specific information about the sequence entry. Here are the main components: Header Section: This includes the LOCUS line, which provides a summary of the entry, including the length of the sequence, the type of molecule (DNA, RNA, or protein), the date of the last update, and the unique accession number. Definition Line: This is the DEFINITION line, which gives a brief description of the sequence. Accession and Version: The ACCESSION line contains the unique identifier for the sequence entry, and the VERSION line indicates the version number of the entry and may include a secondary accession number. Keywords: The KEYWORDS line provides terms that are associated with the sequence and can be used for searching. Source: The SOURCE section describes the organism from which the sequence was derived, including taxonomy and often the specific tissue or cell type. References: This section lists the literature citations associated with the sequence data, including the authors, title, journal, and publication year. Comment: The COMMENT section can contain various types of information, such as the method used for sequence determination, the experimental procedures, or additional notes relevant to the sequence. Features Table: This is one of the most important sections, as it provides a detailed annotation of the sequence. It includes feature key-value pairs that describe the locations and characteristics of genes, exons, introns, regulatory regions, and other sequence features. Sequence Data: The actual nucleotide sequence is presented in the sequence data section, usually in a 60-character-per-line format. This section can be quite long depending on the size of the sequence. File Format: GenBank files are typically plain text files and can be opened with any text editor. However, they are often handled using bioinformatics tools and software that can parse and interpret the data more effectively. The file extension for GenBank files is usually .gb or .gbk. How to Access GenBank: You can access GenBank directly through the NCBI website (https://www.ncbi.nlm.nih.gov/genbank/). Sequences can be searched by various criteria, including accession number, keyword, author, or organism name. Users can also download sequences in various formats, including GenBank flatfile format, FASTA, and others. GenBank providing a wealth of data that scientists use for comparative genomics, evolutionary studies, and many other types of biological research.

01 Syntax

SMRUCC.genomics.Assembly.NCBI.GenBank.GBFF.File

02 Methods

NameOverloadsSummary
Read 1 Read the gene nucleic acid sequence of a gene feature and then returns a fasta sequence object.
op_Implicit 1 Read a specific GenBank database text file.
Load 1 当发生错误的时候,会返回空值
IsValidGenbankFormat 1 检查目标文件是否为Genbank文件格式
LoadDatabase 2 Load multiple genbank assembly data that parsed from a specific data file
Save 1

03 Properties

NameOverloadsSummary
Origin 1 This GenBank keyword section stores the sequence data for this database.
Accession 1 LocusID, GI or AccessionID
Definition 1 The definition value for this organism's GenBank data.
Source 1 物种信息
Locus 1 The brief entry information of this genbank data.
isPlasmid 1 Is plasmid source?
Species 1 the organism species name and strain information of this genbank data, this property is a combination of the source feature's species name and the source feature's strain quali…
Taxon 1 get ncbi taxonomy id
HasSequenceData 1 这个Genbank对象是否具有序列数据
IsWGS 1 This GenBank data is the WGS(Whole genome shotgun) type data.
SourceFeature 1 Gets the original source brief entry information of this genome.(获取这个基因组的摘要信息)
Comment 1
Features 1
Reference 1
Version 1
Keywords 1
DbLinks 1

04 Fields

05 Members

method Read #
Read(Feature)

Read the gene nucleic acid sequence of a gene feature and then returns a fasta sequence object. (读取一个基因特性的核酸序列,该Feature对象可以为任意形式的Qualifier的值,但是必需要具有Location属性)

Parameters
NameTypeDescription
featureFeature

The target feature site on the genome DNA sequence.

method op_Implicit #
op_Implicit(String)

Read a specific GenBank database text file. (读取一个特定的GenBank数据库文件)

Parameters
NameTypeDescription
PathString

The target database text file to read.(所要读取的目标数据库文件)

method Load #
Load(String)

当发生错误的时候,会返回空值

Parameters
NameTypeDescription
pathString

-

method IsValidGenbankFormat #
IsValidGenbankFormat(String)

检查目标文件是否为Genbank文件格式

Parameters
NameTypeDescription
pathString

-

method LoadDatabase overload 2 #
LoadDatabase(String, Boolean)

Using this function to load the ncbi genbank database file if the database file contains more than one genome.

Remarks

(假若一个gbk文件之中包含有多个记录的话,可以使用这个函数进行数据的加载,多个genebank记录在一个文件之中 一般出现在细菌具有染色体基因组和质粒基因组这种多个复制子的情况)

Parameters
NameTypeDescription
filePathString

The file path of the genbank database file, this gb file may contains sevral gb sections

method LoadDatabase #
LoadDatabase(Stream, String, Boolean)

Load multiple genbank assembly data that parsed from a specific data file

Parameters
NameTypeDescription
fileStream

-

defaultAccessionString

-

suppressErrorBoolean

-

property Origin #
Origin

This GenBank keyword section stores the sequence data for this database.

property Accession #
Accession

LocusID, GI or AccessionID

property Definition #
Definition

The definition value for this organism's GenBank data.

property Source #
Source

物种信息

property Locus #
Locus

The brief entry information of this genbank data.

property isPlasmid #
isPlasmid

Is plasmid source?

Remarks

(这个Genbank对象是否为一个质粒的基因组数据)

property Species #
Species

the organism species name and strain information of this genbank data, this property is a combination of the source feature's species name and the source feature's strain qualifier value.

property Taxon #
Taxon

get ncbi taxonomy id

Remarks

物种数据

property HasSequenceData #
HasSequenceData

这个Genbank对象是否具有序列数据

property IsWGS #
IsWGS

This GenBank data is the WGS(Whole genome shotgun) type data.

property SourceFeature #
SourceFeature

Gets the original source brief entry information of this genome.(获取这个基因组的摘要信息)

field GenbankMultipleRecordDelimiterRegexp #
GenbankMultipleRecordDelimiterRegexp
field GenbankMultipleRecordDelimiter #
GenbankMultipleRecordDelimiter
property Comment #
Comment
property Features #
Features
property Reference #
Reference
property Version #
Version
property Keywords #
Keywords
method Save #
Save(String, Encoding)