transChecker User's Manual
DDBJ 大量登録システム(MSS)
目次
1.
transChecker とは ... 1
2.
使用準備 ... 1
2-1.
実行環境について ... 1
2-2.
UME で使用する場合 ... 1
2-3.
単体のコマンドラインで使用する場合 ... 2
3.
出力フォーマット ... 4
3-1.
エラーメッセージのフォーマット ... 4
3-2.
アミノ酸配列ファイルのフォーマット ... 5
4.
エラーメッセージ一覧 ... 6
4-1.
FATAL レベル ... 6
4-2.
ERROR レベル ... 7
4-3.
WARNING レベル ... 11
1
1.
transChecker とは
"transChecker"は、塩基配列の登録に必要な"アノテーションファイル"と"配列ファイル"の記載を元に CDS feature のアミノ酸翻訳チェックを行うツールです。両ファイルの作成に関しては、"大量登録用データ作成 の手引き"をご参照下さい。 "transChecker"を使用する前に、必ず、"Parser"によるチェックを行い、ファイルに書式エラーがないこと を確認してください。"Parser"の使用方法に関しましては、"Parser User's Guide" をご参照ください。 ツールとマニュアルは下記サイトからダウンロード可能です。 DDBJ 大量登録ホームページ: URL: http://www.ddbj.nig.ac.jp/sub/mss/massSub-j.html CDS の記載に際しましては、下記のサイトもご参照ください。 タンパク質コード配列; CDS feature について URL: http://www.ddbj.nig.ac.jp/sub/cds-j.html2.
使用準備
ご利用前に 5.End-user license agreement をご確認ください。
2-1. 実行環境について
必要なハードウェア環境
インストールのための 20 MB 以上のハードディスク領域 512 MB 以上(推奨 1 GB 以上) の RAM
必要なソフトウェア環境
本ツールは Java 言語を用いて作られておりますので、原則、Java Runtime Environment 1.7 以降の実行環 境であれば、互換性があるものと推定します。DDBJ では、推奨 OS として、以下の環境で動作確認を行って おります。
WindowsXP/Vista/7, MacOSX 10.8, Ubuntu 10.04
2-2. UME で使用する場合
transChecker は"UME" (Utilities f'transl_table' qualifier has invalidor MSS Error check)の一部として 組み込まれています。下記のサイトから"UME"を取得し、"UME User's Manual"に従い、インストール・起動 して下さい。
DDBJ 大量登録ホームページ:
2
2-3. 単体のコマンドラインで使用する場合
Windows の場合はご利用いただけませんので、UME をご利用ください。 2-3-1. インストール transChecker を利用するために、以下の手順で設定してください。 1) 下記のサイトから transChecker.tar.gz を取得します。 URL: http://www.ddbj.nig.ac.jp/sub/mss/massSub-j.html 2) transChecker.tar.gz を gunzip コマンドで解凍します。 %gunzip transChecker.tar.gz 3) tar コマンドで展開します。 %tar xvf transChecker.tar 4) transChecker ディレクトリが生成されます。 下記の要領で、transChecker ディレクトリの中身を見ると以下のようになっています。 %cd transChecker %ls -FC transChecker.sh* jar/ transChecker.sh 実行シェルスクリプト jar/ java のクラスライブラリ格納ディレクトリ（改変不可） 5) transChecker.sh を実行する前にこのファイルの中身を、インストールしたコンピュータの環境にあわせ るために変更する必要があります。vi などのエディタで編集して下さい。 %vi transChecker.sh [TRANS_DIR 変数] transChecker ディレクトリのある場所を絶対パスで入力して下さい。 ex) TRANS_DIR=/home/mass/transChecker [HEAP_SIZE 変数] transChecker が使用できる最大メモリ量を指定してください。 ex) HEAP_SIZE=128m 6) PATH に transChecker.sh が設置してあるディレクトリを指定して下さい。3
2-3-2. 実行
任意のディレクトリで下記の要領で、コマンドを実行して下さい。
%transChecker.sh[space]-x[アノテーションファイル名][space]-s[塩基配列ファイル名] ([space]-e[実行結果保存用ファイル名][space]-o[アミノ酸配列ファイル名])
入力例) transChecker.sh -xsample.ann -ssample.fasta -eerrmsg.txt -orsl.fasta
ファイル名は、相対パス・絶対パスの双方で指定が可能です。 1) -x[アノテーションファイル名] このオプションは必須です。指定されていない場合、本ツールは終了します。 "アノテーションファイル"はタブ区切りのテキストファイルです。書式の詳細に関しては、"大量登録用デー タ作成の手引き"をご参照下さい。 また、実行前に"Parser"によるチェックでエラーがないことをご確認ください。 2) -s[塩基配列ファイル名] このオプションは必須です。指定されていない場合、本ツールは終了します。 "塩基配列ファイル" は fasta 形式のテキストファイルです。書式の詳細に関しては、"大量登録用データ作 成の手引き"をご参照下さい。 また、実行前に Parser によるチェックでエラーがないことをご確認ください。 3) -e[実行結果保存用ファイル名] アミノ酸配列への翻訳過程で生じたエラーメッセージを出力するファイルの名称を指定します。 このオプションが指定されてない場合は、エラーメッセージは、stdout で出力されます。 出力フォーマットは3-1, および 4 をご参照ください。 4) -o[アミノ酸配列ファイル名] 翻訳結果のアミノ酸配列を出力するファイルの名称を指定します。 このオプションが指定されていない場合、アミノ酸配列は出力されません。 出力フォーマットは3-2をご参照ください。
4
3.
出力フォーマット
3-1. エラーメッセージのフォーマット
エラーが発生していない場合は、メッセージ自体を出力しません。 エラーが発生した場合、エラーメッセージごとに必要な対処方法が異なります。 適宜、対処をお願いいたします。 問題点、不明点等は、メッセージとともに[email protected]までご連絡下さい。 書式>[Entry name].[Serial Number][space][CDS feature location] Error message 1 Error message 2 : : Error message N // 各エラーメッセージは " [Level] メッセージ本文 " の形式で出力されます。
[Level] は、検出されたエラーの種別を示します。[FATAL], [ERROR], [WARNING] の３種類があります。メ
ッセージ本文は、検出されたエラーの個別内容を示します。
例
>entry1.1 <1..>366
[WARNING] 'codon_start' qualifier should be selected. The value is automatically set 1. [WARNING] 'transl_table' qualifier should be selected. The value is automatically set 1. //
>entry2.3 4315..4997
[ERROR] First codon [cct] is not a start codon. [ERROR] Final codon [cat] is not a stop codon. [ERROR] Stop codon '*' is found in the range. //
5
3-2. アミノ酸配列ファイルのフォーマット
Fasta 形式で出力します。エラーがある場合でも、CDS feature で示される塩基配列に対応するアミノ酸配列 をその状態で出力しますが、エラーの程度により出力されないこともあります。
書式
>[Entry name].[Serial Number][space][CDS feature location] [翻訳結果アミノ酸配列 (60 文字/行)] // 出力例 >entry1.1 89..406 MLARISELTKIGTTIFIVAIDQVAEPNSWGSSQLVLLAKIAGALKAIPPNPVCTSRHRQA ASVSPFRSAIVGTLLQLEAIKNLLTVSVDTIQQNGVLFIFVALLR // >entry1.2 684..1325 MSIGILGTKLGMTQIFDESGKAVPVTVIQAGPCPITQIKTVATDGYNAIQIGFLEVREKQ LSKPELGHLSKAGAPPLRHLLEYRVPSTDGLELGQALTADRFEAGQKVDVQGHTIGRGFT GYQKRHGFARGPMSHGSKNHRLPGSTGAGTTPGRVYPGKRMAGRSGNDKTTIRGLTVVRV DADRNLLLVKGSVPGKPGALLNITPATVVGQQA //
6
4.
エラーメッセージ一覧
以下の項では、エラーレベルごとに各エラーメッセージの概要を説明しています。 エラーメッセージが出た場合は、適宜、修正し解消する必要があります。 問題、不明点などがございましたら、[email protected] にエラーメッセージを添えてご連絡ください。4-1. FATAL レベル
FATAL レベルのエラーが出る場合は、システム上の障害（リソースファイルがない、本ツールの不具合）の 可能性があります。[FATAL] Proper 'codon.table' is not found in 'resource/codon' folder.
ファイル（codon.table）が所定のフォルダ（resource/codon）にあるか確認して下さい。 ---
[FATAL] Proper 'amino.table' is not found in 'resource/codon' folder.
ファイル（amino.table）が所定のフォルダ（resource/codon）にあるか確認して下さい。 ---
[FATAL] Proper 'transltabs.list' is not found in 'resource/FQ' folder.
ファイル（transltabs.list）が所定のフォルダ（resource/FQ）にあるか確認して下さい。 ---
[FATAL] Unable to execute Translation.
何らかの理由で、アミノ酸翻訳機能を実行できません。
システムエラーの可能性が高いので、[email protected] までその旨をご連絡下さい。 ---
7
4-2. ERROR レベル
ERROR レベルのエラーは、データの入力間違いと推定されるエラーです。これらのエラーが出た場合にはフ ァイルに何らかの誤りがありますので、修正の上、エラーを解消してください。 括弧、[ と ]、で囲まれ、# で始まる赤字の語句は、検査したファイルで実際に使用されていた文字列に置 換されて出力されます。 4-2-1. Location CDS feature の location に関するエラーです。修正が必要です。[ERROR] Description of Location [#location of CDS feature] is illegal.
CDS feature の location 記載に誤りがあります。 Location の記述法に関しては、下記のサイトを参照してください。 塩基配列登録のための参考資料: Location の記述法 URL: http://www.ddbj.nig.ac.jp/sub/ref9-j.html --- 4-2-2. codon_start codon_start qualifier に関するエラーです。修正が必要です。
[ERROR] 'codon_start' qualifier is duplicated. The value is automatically set 1.
codon_start qualifier が複数存在します。アミノ酸配列の翻訳はデフォルト値、1 として行いました。 codon_start qualifier は CDS feature 1 つに対して 1 つしか入力できません。
---
[ERROR] 'codon_start' qualifier has invalid value [#Value].
codon_start qualifier の値が不正です。"1", "2", "3" の何れかのみ記載可能です。 ---
8
4-2-3. transl_table
transl_table qualifier に関するエラーです。修正が必要です。
[ERROR] 'transl_table' qualifier is duplicated. The value is automatically set 1.
transl_table qualifier が複数存在します。アミノ酸配列の翻訳はデフォルト値、1 として行いました。 transl_table qualifier は CDS feature 1 つに対して１つしか入力できません。
---
[ERROR] 'transl_table' qualifier has invalid value [#Value].
transl_table qualifier の値が不正です。The Genetic Codes で規定されている番号を使用して下さい。 The Genetic Codes
URL: http://www.ncbi.nlm.nih.gov/Taxonomy/Utils/wprintgc.cgi?mode=c
---
4-2-4. transl_except
transl_except qualifier に関するエラーです。修正が必要です。
[ERROR] Amino acid abbreviation [#abbreviation] in 'transl_except' qualifier is illegal.
transl_except qualifier の値にあるアミノ酸３文字表記が不正です。 使用可能な表記は下記のサイトで確認してください。
塩基配列登録のための参考資料: Amino Acid Codes URL: http://www.ddbj.nig.ac.jp/sub/ref2-j.html
---
[ERROR] 'transl_except' qualifier has invalid value [#Value].
transl_except qualifier の値が不正です。書式は下記のサイトで確認してください。 The DDBJ/EMBL/GenBank Feature Table: Definition
URL: http://www.ddbj.nig.ac.jp/FT/full_index.html
---
[ERROR] Location of 'transl_except' qualifier [#Value] is overlapped.
transl_except qualifier の値の中にある location (<base_range>) に重なりがありますので、記載を無視 してアミノ酸へ翻訳しています。
9
[ERROR] Location of 'transl_except' qualifier [#Value] is invalid.
transl_except qualifier の値の中にある location (<base_range>)に誤りがあります。 書式は下記のサイトで確認してください。
The DDBJ/EMBL/GenBank Feature Table: Definition URL: http://www.ddbj.nig.ac.jp/FT/full_index.html
---
[ERROR] Base range of 'transl_except' qualifier [#Value] is mismatched in reading frame.
transl_except qualifier で指定された値中の location (<base range>)が、CDS feature の 読み枠と合いませんので値を修正してください。
---
[ERROR] Amino acid of 'transl_except' qualifier [#Value] is not changed from conceptual translation.
transl_except qualifier で指定されたアミノ酸と通常の翻訳によるアミノ酸が同一です。 この transl_except qualifier は削除してください。
---
[ERROR] Amino acid of 'transl_except' qualifier [#Value] is not [TERM].
transl_except qualifier で CDS feature の終止位置に終止コドン以外を指定しています。 Location、または、transl_except qualifier を修正してください。
---
[ERROR] Stop codon is specified by 'transl_except' qualifier [#Value] in mid of CDS location.
CDS feature 終止位置以外で transl_except qualifier で終止コドンを指定しています。 この transl_except qualifier は削除してください。
10
4-2-5. その他
[ERROR] Entry [#Entry name] is NOT found in sequence entries.
配列ファイルに存在しないエントリー名をアノテーションファイルで指定しています。 エントリー名を確認の上、修正して下さい。
---
[ERROR] Untranslatable codon [#Codon] is found in the sequence range.
塩基配列中に、アミノ酸配列に翻訳不可能なコドンが含まれています。 ---
[ERROR] First codon [#Codon] is not a start codon.
CDS feature が開始コドンから始まっていません。Location の記載を確認して下さい。 CDS が全長ではない場合は、partial 記号 "<" が必要です。
---
[ERROR] Final codon [#Codon] is not a stop codon.
CDS feature が終止コドンで終わっていません。Location の記載を確認して下さい。 CDS が全長ではない場合は、partial 記号 ">" が必要です。
---
[ERROR] Stop codon '*' is found in the range.
CDS feature の途中に終止コドンが出現しました。 ---
11
4-3. WARNING レベル
WARNING レベルは注意を促すメッセージです。修正が必要な場合もあります。
[WARNING] 'codon_start' qualifier should be selected. The value is automatically set 1.
codon_start qualifier が入力されていません。
アミノ酸翻訳ダイアログには初期設定の値(1) で翻訳された結果が表示されています。 ---
[WARNING] 'transl_table' qualifier should be selected. The value is automatically set 1.
transl_table qualifier が入力されていません。
アミノ酸翻訳ダイアログには初期設定の値(1) で翻訳された結果が表示されています ---
[WARNING] Amino acid of 'transl_except' qualifier [#Value] is not [Met].
CDS feature の開始位置に transl_except qualifier で Met 以外のアミノ酸を指定しています。 ---
[WARNING] [#Value] codons are not translable.
CDS feature のアミノ酸配列翻訳を行うと特定のアミノ酸に翻訳することができないコドンが [#Value] 個 ありました。
12
5.
End-user license agreement
ご使用前に，必ずお読みください。
NOTICE TO USERS:
Carefully read the following agreement.
Use of the tools for Mass Submission System provided by DDBJ with this agreement (hereinafter collectively called "the Software") constitutes your acceptance of these terms.
If you do not agree to the terms of this agreement, do not install and/or use the Software. User's use of the Software is conditioned upon compliance by user with the terms of this agreement.
(1)All copyright related to the Software except the following third-party software (included in only "UME") must belong to the DDBJ:
a) Axis 1.1 b) Xerces 1.4.4
The Software includes the source code thereof and documentation thereto.
(2)In the event you provide to any third party all or any portion of the Software, prior written consent of DDBJ is required.
(3)You agree that you will not attempt to reverse compile, modify, translate, or disassemble the Software in whole or in part.
(4)Except as required by law, DDBJ will not be liable to you for any damages arising out of the use or inability to use of the Software.
13
