nuget server logo nuget api documents
↑

API Docs / SMRUCC.genomics.Data.Repository / KEGGApi

KEGGApi

Full name SMRUCC.genomics.Data.KEGGApi Assembly SMRUCC.genomics.Data.Repository Members 5

01 Syntax

SMRUCC.genomics.Data.KEGGApi

02 Methods

NameOverloadsSummary
GetInformation 2 This operation displays the database release information with statistics for the databases shown in Table 1.
List 1 This operation can be used to obtain a list of all entries in each database.
Find 1 This is a search operation.
GetObject 1

03 Members

method GetInformation #
GetInformation(database)

This operation displays the database release information with statistics for the databases shown in Table 1. Except for kegg, genes and ligand, this operation also displays the list of linked databases that can be used in the link operation.

Parameters
NameTypeDescription
databasedatabase

-

method GetInformation overload 2 #
GetInformation(String)

This operation displays the database release information with statistics for the databases shown in Table 1. Except for kegg, genes and ligand, this operation also displays the list of linked databases that can be used in the link operation.

Parameters
NameTypeDescription
databaseString

-

method List #
List(String, String)

This operation can be used to obtain a list of all entries in each database. The database names shown in Tables 1 and 2, excluding the composite database names of genes, ligand and kegg, may be given. The special database name "organism" is allowed only in this operation, which may be used to obtain a list of KEGG organisms with the three- or four-letter organism codes. The option "xl" Is applicable only to the brite database for listing binary relation files, which are used to expand brite hierarchies by the Join Brite tool in KEGG Mapper. When the organism code Is known, the second form can be used to obtain a list of organism-specific pathways Or modules. The third form may be used To obtain a list Of definitions For a given Set Of database entry identifiers. The maximum number Of identifiers that can be given Is 10.

Parameters
NameTypeDescription
databaseString

-

orgString

-

method Find #
Find(String, String, String)

This is a search operation. The first form searches entry identifier and associated fields shown below for matching keywords.

DatabaseText search fields (see flat file format)
pathwayENTRY And NAME
moduleENTRY And NAME
koENTRY, NAME And DEFINITION
genes (<org>, vg, vp, ag)ENTRY, ORTHOLOGY, NAME And DEFINITION
genomeENTRY, NAME And DEFINITION
compoundENTRY And NAME
glycanENTRY, NAME And COMPOSITION
reactionENTRY, NAME And DEFINITION
rclassENTRY And DEFINITION
enzymeENTRY And NAME
networkENTRY And NAME
variantENTRY And NAME
diseaseENTRY And NAME
drugENTRY And NAME
dgroupENTRY And NAME

Keyword search against brite Is Not supported. Use /list/brite To retrieve a Short list.

In the second form the chemical formula search Is a partial match irrespective of the order of atoms given. The exact mass (Or molecular weight) Is checked by rounding off to the same decimal place as the query data. A range of values may also be specified with the minus(-) sign.

Parameters
NameTypeDescription
databaseString

-

queryString

-

[option]String

-

method GetObject #
GetObject(String)