Amazon Omics Analytics の Annotation Store で定義可能なスキーマの型の確認方法

APIリファレンスも確認しないと必要な情報を得ることができない
2023.02.22

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

TSV/CSV 形式のアノテーションファイルを Annotation Store へインポートする際に必要な情報を探すために時間がかったので共有します。

確認結果

スキーマ定義可能な型一覧

  • 数値: LONG, INT, FLOAT, DOUBLE
  • 文字列: STRING
  • 真偽値: BOOLEAN

参考: TsvStoreOptions - Amazon Omics

困っていた内容

アノテーションストア作成時にTSV and CSV formatsを選択する際には JSON 形式でスキーマの定義のファイルのアップロードが必要です。スキーマ定義可能な型は何があるのでしょうか?

スキーマ定義可能な型の情報が公式ドキュメント(Developer Guide)を確認しても見当たりません。

Creating and managing annotation store examples - Amazon Omics

確認方法

現時点ではよく確認する公式ドキュメントには未記載です。代わりに API リファレンスから該当する項目を探して有効な値を確認できます。

TsvStoreOptions - Amazon Omics

スキーマ定義可能な型は下記になります。

  • 数値: LONG, INT, FLOAT, DOUBLE
  • 文字列: STRING
  • 真偽値: BOOLEAN

実際に定義した JSON ファイルをみてみたい

aws omicsコマンドのリファレンスを参考にしてください。

create-annotation-store — AWS CLI 2.10.1 Command Reference

アノテーション情報を TSV/CSV フォーマットで記述したファイルに対応する Annotation Store を作成するときに必要となる JSON ファイルのサンプルです。

{
    "tsvStoreOptions": {
        "annotationType": "CHR_START_END_ZERO_BASE",
        "formatToHeader": {
            "CHR": "chromosome",
            "START": "start",
            "END": "end"
        },
        "schema": [
            {
                "chromosome": "STRING"
            },
            {
                "start": "LONG"
            },
            {
                "end": "LONG"
            },
            {
                "name": "STRING"
            }
        ]
    }
}

おわりに

私の様にお困りの方の参考になれば幸いです。

参考