Skip to content

Commit

Permalink
Merge pull request #35 from dbcls/update_togoid_docs
Browse files Browse the repository at this point in the history
update TogoID documents
  • Loading branch information
sakumakeiko authored Oct 28, 2024
2 parents e7163d2 + 8f6d233 commit 34eb136
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 23 deletions.
31 changes: 18 additions & 13 deletions services/TogoID_en.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,41 @@
# TogoID
## About TogoID
TogoID is a web application that allows you to search and convert links between identifiers(IDs) of databases(DBs) in the life sciences. [https://togoid.dbcls.jp/](https://togoid.dbcls.jp/)
TogoID is a web application that allows you to convert identifiers (IDs) across diverse databases (DBs) in the life sciences. [https://togoid.dbcls.jp/](https://togoid.dbcls.jp/)

## Features of TogoID
- When you enter a list of IDs (up to thousands), DBs of conversion candidates are listed, and then you can convert them to the corresponding IDs. In addition to one-to-one ID conversion, it is also possible to convert including the route to the target DB.
- TogoID provides the ability to retrieve converted IDs in various formats: 1. copy it to the clipboard for immediate use in other services, 2. get a list of converted IDs in text format, 3. get a list of converted IDs in a format that includes a link URL to the original DB, 4. get a list of converted IDs in CSV format that includes all of the conversion routes.
- Links between databases is maintained by the [togoid-config](https://github.com/dbcls/togoid-config) which extracts a pair of identifiers from a SPARQL query for RDF data, database specific APIs, and the flat files of original data sources. See the "DATABASES" tab on the TogoID website for a list of supported databases.
- As of July 2021, TogoID contains more than 150 ID pairs from more than 60 DBs(constantly expanding). By maintaining the metadata about the IDs in the target DB, the update method of ID pairs, and the update frequency, TogoID provides the latest information on the links between IDs.
- When you enter or upload a list of IDs, the candidate DBs are listed, and then you can convert the IDs to IDs of other databases. The converted IDs can be subsequently converted to other IDs.
- TogoID covers a wide range of categories of DBs such as gene, protein, variant, disease, pathway, chemical compound, structure, biological sample, cell line, publication, etc.
- Users can not only convert between IDs within the same category, but also between IDs of different categories that are related in different biological meanings, such as "genes in which a variant is located" or "pathways in which a protein participates". The semantics of the relationship is organized in an ontology, and the meaning is displayed on the arrows connecting the DBs in the web UI.
- The conversion results can be downloaded in CSV or TSV format or copied to the clipboard.
- The ID pairs stored in the TogoID system are maintained by programs to collect the ID relations from original DBs. As of October 2024, more than 70 DBs are included.
- The data is updated weekly, allowing users to refer to the most recent data for conversion.
- Users can obtain the labels, such as gene symbols, for conversion result IDs. For some DBs, users can also convert labels to IDs.
- The programs are managed in the GitHub repository TogoID-config (https://github.com/togoid/togoid-config). Anyone can send a pull request to add a method to obtain new ID pairs.
- TogoID is also available as an API, which allows other applications to use it for ID conversion.
- Examples:
1. [https://api.togoid.dbcls.jp/convert?ids=5460,6657,9314,4609&route=ncbigene,ensembl_gene&format=json](https://api.togoid.dbcls.jp/convert?ids=5460,6657,9314,4609&route=ncbigene,ensembl_gene&format=json)
2. [https://api.togoid.dbcls.jp/convert?ids=5460,6657,9314,4609&route=ncbigene,ensembl_gene,uniprot&format=json](https://api.togoid.dbcls.jp/convert?ids=5460,6657,9314,4609&route=ncbigene,ensembl_gene,uniprot&format=json)
3. [https://api.togoid.dbcls.jp/convert?format=json&include=pair&route=pubchem_compound,chebi,reactome_reaction,uniprot,ncbigene&ids=649](https://api.togoid.dbcls.jp/convert?format=json&include=pair&route=pubchem_compound,chebi,reactome_reaction,uniprot,ncbigene&ids=649)
- Example: [Convert NCBI Gene IDs to PDB IDs via UniProt IDs and obtain the result as JSON](https://api.togoid.dbcls.jp/convert?ids=5460,6657,9314,4609&route=ncbigene,uniprot,pdb&format=json&report=full)

## Screenshots

### Exploratory ID conversion from top page (EXPLORE mode)
### Exploratory ID conversion (EXPLORE mode)

![Fig-1](https://raw.githubusercontent.com/dbcls/website/master/services/images/TogoID_Fig1_20220520.jpg)

### NAVIGATE mode which allows the user to specify the conversion target
### Finds paths to connect the input to a target (NAVIGATE mode)

![Fig-2](https://raw.githubusercontent.com/dbcls/website/master/services/images/TogoID_Fig2_20220520.jpg)


### Results window for ID conversion

![Fig-2](https://raw.githubusercontent.com/dbcls/website/master/services/images/TogoID_Fig4_20220520.jpg)
![Fig-4](https://raw.githubusercontent.com/dbcls/website/master/services/images/TogoID_Fig4_20241025.jpg)

### Convert labels to IDs (LABEL2ID)

![Fig-5](https://raw.githubusercontent.com/dbcls/website/master/services/images/TogoID_Fig5_20241025.jpg)

### DATASETS tab to view a list of datasets

![Fig-3](https://raw.githubusercontent.com/dbcls/website/master/services/images/TogoID_Fig3_20220520.jpg)
![Fig-3](https://raw.githubusercontent.com/dbcls/website/master/services/images/TogoID_Fig3_20241025.jpg)


### References
Expand Down
23 changes: 13 additions & 10 deletions services/TogoID_ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,35 +5,38 @@ TogoID は 生命科学分野におけるデータベース(DB)のID間の対応

## TogoID の特徴
- IDリストを入力することで、直接変換可能なDBが列挙され、対応するIDに変換することができます。1対1のID変換だけでなく、あるDBを経由してさらに他のDBのIDに変換することも可能です。
- 等価なものに対するID間の変換だけでなく、「 バリアントが位置する遺伝子」のように、何らかの生物学的意味で関係する別概念のIDに変換することも可能です。関係の意味はオントロジーで整理しており、ウェブUI上ではDB間をつなぐ矢印上に意味が表示されます。
- 遺伝子、タンパク質、バリアント、疾患、パスウェイ、化合物、立体構造、実験サンプル、細胞株、文献など、幅広いカテゴリーのDBを対象としています。
- 等価なものに対するID間の変換だけでなく、「バリアントが位置する遺伝子」のように、何らかの生物学的意味で関係する別概念のIDに変換することも可能です。関係の意味はオントロジーで整理しており、ウェブUI上ではDB間をつなぐ矢印上に意味が表示されます。
- 変換結果は、CSVやTSVの形式でダウンロードしたりクリップボードにコピーしたりできます。
- ID間の対応関係は、各DBのRDFデータ、API、フラットファイルからの抽出によって整備しており、2023年11月現在、70以上のDBが対象になっています。
- ID間の対応関係は、各DBのRDFデータ、API、フラットファイルからの抽出によって整備しており、2024年10月現在、70以上のDBが対象になっています。
- データは毎週定期更新を行っており、常に最新に近いデータを参照して変換できます。
- 遺伝子シンボルや疾患名など、ID に対するラベルを表示することができます。一部のデータセットでは、ラベルをIDに変換することもできます。
- 対象DBのIDに関するメタデータや、IDペアの取得方法は、GitHub レポジトリ TogoID-config ([https://github.com/togoid/togoid-config](https://github.com/togoid/togoid-config)) で管理しています。また、誰でも新規のIDペアの取得方法を追加して、プルリクエストを送ることができます。
- ウェブインターフェイスだけでなく、APIも用意しており、他のアプリケーションからのID変換にも利用することができます。
- 例1: [https://api.togoid.dbcls.jp/convert?ids=5460,6657,9314,4609&route=ncbigene,ensembl_gene&format=json](https://api.togoid.dbcls.jp/convert?ids=5460,6657,9314,4609&route=ncbigene,ensembl_gene&format=json)
- 例2: [https://api.togoid.dbcls.jp/convert?ids=5460,6657,9314,4609&route=ncbigene,ensembl_gene,uniprot&format=json](https://api.togoid.dbcls.jp/convert?ids=5460,6657,9314,4609&route=ncbigene,ensembl_gene,uniprot&format=json)
- 例3: [https://api.togoid.dbcls.jp/convert?format=json&include=pair&route=pubchem_compound,chebi,reactome_reaction,uniprot,ncbigene&ids=649](https://api.togoid.dbcls.jp/convert?format=json&include=pair&route=pubchem_compound,chebi,reactome_reaction,uniprot,ncbigene&ids=649)

- 例: [NCBI Gene ID を UniProt ID 経由で PDB ID に変換した結果を json で取得する](https://api.togoid.dbcls.jp/convert?ids=5460,6657,9314,4609&route=ncbigene,uniprot,pdb&format=json&report=full)

## スクリーンショット

### トップページから探索的にID変換(EXPLOREモード)
### 探索的にID変換 (EXPLOREモード)

![Fig-1](https://raw.githubusercontent.com/dbcls/website/master/services/images/TogoID_Fig1_20220520.jpg)

### トップページから最終的に変換したいIDを決めてID変換(NAVIGATEモード)
### 変換したいデータセットへのパスを検索してID変換 (NAVIGATEモード)

![Fig-2](https://raw.githubusercontent.com/dbcls/website/master/services/images/TogoID_Fig2_20220520.jpg)


### ID変換の結果

![Fig-2](https://raw.githubusercontent.com/dbcls/website/master/services/images/TogoID_Fig4_20220520.jpg)
![Fig-4](https://raw.githubusercontent.com/dbcls/website/master/services/images/TogoID_Fig4_20241025.jpg)

### ラベルをIDに変換 (LABEL2ID)

![Fig-5](https://raw.githubusercontent.com/dbcls/website/master/services/images/TogoID_Fig5_20241025.jpg)

### 収載DBのIDに関する情報

![Fig-3](https://raw.githubusercontent.com/dbcls/website/master/services/images/TogoID_Fig3_20220520.jpg)
![Fig-3](https://raw.githubusercontent.com/dbcls/website/master/services/images/TogoID_Fig3_20241025.jpg)


### 参考文献
Expand Down
Binary file added services/images/TogoID_Fig3_20241025.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added services/images/TogoID_Fig4_20241025.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added services/images/TogoID_Fig5_20241025.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 34eb136

Please sign in to comment.