pmsignature レポート¶

ここでは、サンプルデータ [*] を使用して、pmsignature レポートを出力するために必要な入力データと設定方法を解説します。

[*]	サンプルデータは paplot をダウンロードして解凍したディレクトリ中、example ディレクトリにあります。

pmsignature 実行手順の手順でデータの準備を行う場合、設定ファイルの変更は必要ありません。

1. jsonフォーマット¶

paplot で pmsignature レポートを作成するためには Mutation Matrix レポートや Chromosomal Aberration レポート、QC レポートとは異なり、json ファイル形式で pmsignature データを用意する必要があります。

ここでは、paplot が使用する pmsignature データのフォーマットについて解説します。

exampleのデータファイルをテキストエディタで開くと次のようになっています。(長いため一部省略しています)

example/pmsignature_stack/data2.json¶

{
  "ref":[
          [ # pmsignature 1
            [0.338,0.15,0.183,0.327],  # ref1 (A,C,G,T)
            [0.362,0.191,0.177,0.267], # ref2 (A,C,G,T)
            [0,0.731,0,0.268],         # ref3 (A,C,G,T)
            [0.31,0.165,0.251,0.272],  # ref4 (A,C,G,T)
            [0.295,0.193,0.168,0.341]  # ref5 (A,C,G,T)
          ],
          [ # pmsignature 2
            [0.179,0.414,0.084,0.321],
            [0.007,0.025,0.004,0.962],
            [0,0.999,0,0],
            [0.472,0.104,0.041,0.381],
            [0.277,0.175,0.284,0.262]
          ]
        ],
  "alt":[
          [ # pmsignature 1
            [0,0,0,0],                 # altA (A,C,G,T)
            [0.194,0,0.091,0.445],     # altC (A,C,G,T)
            [0,0,0,0],                 # altG (A,C,G,T)
            [0.093,0.163,0.011,0]      # altT (A,C,G,T)
          ],
          [ # pmsignature 2
            [0,0,0,0],
            [0.059,0,0.437,0.502],
            [0,0,0,0],
            [0,0,0,0]
          ]
        ],
  "strand":[
            [0.461,0.538],  # pmsignature 1
            [0.512,0.487]   # pmsignature 2
           ],
  "id":["PD3851a","PD3890a","PD3904a"],
  "mutation":[[0,0,0.535],[0,1,0.038],[0,2,0.426],[1,0,0.186],[1,1,0.156],[1,2,0.656]],
  "mutation_count":[702,2312,2096]
}

pmsignature レポートを作成するためのデータ要素

ref:	各 pmsignature のリファレンス塩基 (A → C → G → T の順) の値です。 paplot が再計算しますので、合計して 1 になる必要はありません。今回の例では base の数を 5 にしていますが、3 や 7 など奇数であれば変更可能です。 base とは、変異の位置 (N) を基準として、前後の塩基の数を意味します。base が 3 である場合、前後の塩基の数はそれぞれ 1 つです。base が 5 である場合、前後の塩基の数はそれぞれ 2 つです。
alt:	各 pmsignature の alternative 塩基 (各中央のリファレンス塩基に対して A → C → G → T の順) の値です。各リファレンス塩基 A, C, G, Tの 4 つの値を A → C → G → T の順に記入します。したがって、各 pmsignature には合計 16 の値が必要です。通常、中央の塩基は C または T に固定されているため、参照塩基が A または G の値はゼロに設定できます。
strand:	各 pmsignature の strand (plus → minus の順) の値です。 strand が無い場合は `[0,0]` を記入します。

寄与度グラフ描画データ

この項目はオプションです。

寄与度グラフは、各 pmsignature に関連づけられている変異はどれくらいの数かを示す積み上げグラフです。入力 json ファイルに id, mutation, mutation_count が設定されている場合、サンプル毎に pmsignature の寄与度グラフ ( 例 ) を作成します。

id:	サンプル名のリストです。
mutation_count:	サンプルごとの変異数です。上記の例の場合、PD3851a の変異数=702、PD3890a の変異数=2312、PD3904a の変異数=2096 となります。
mutation:	サンプルごと、pmsignature ごとの割合を設定します。 [sample index, pmsignature index, value] の順に記載します。 `sample index` は `id` で記載した順に 0 からカウントします。上記の例の場合の `sample index` は PD3851a=0、PD3890a=1、PD3904a=2 となります。 `pmsignature index` は `ref` で記載した順に 0 からカウントします。 background を使用する場合、signature1, signature2, ..., background の順にカウントします。上記の例の場合の `pmsignature index` は signature1 = 0、signature2 = 1、background = 2 となります。

注釈

キーは変更可能です。キーを変更した場合は設定ファイル ([result_format_pmsignature] セクションの key_* オプション) を変更してください。

example/pmsignature_stack/paplot.cfg¶

[result_format_pmsignature]
format = json
background = True
key_ref = ref
key_alt = alt
key_strand = strand
key_id = id
key_mutation = mutation
key_mutation_count = mutation_count

注釈

json ファイルの確認

paplot は python の json パッケージを使用しているため、次のコマンドで読めれば OK です。

json パッケージを使用したファイル確認例 (ファイル名が "data2.json" の場合)

$ python
>>> import json
>>> json.load(open("data2.json"))

2. 最小データセット¶

このセクションで生成するレポートを見る
このセクションで使用するデータセットを見る
このセクションで使用するデータセットをダウンロードする

入力データ形式は 1. jsonフォーマット参照。

pmsignature 実行手順に従いデータの準備を行う場合、設定ファイルの変更は必要ありません。

データファイル (pmsignature 数は 2)

example/pmsignature_minimal/data.json¶

{
  "ref":[[[0.189,0.395,0.088,0.326],[0.019,0.029,0.01,0.94],[0,0.999,0,0],[0.467,0.103,0.054,0.374],[0.278,0.175,0.276,0.268]]],
  "alt":[[[0,0,0,0],[0.063,0,0.415,0.521],[0,0,0,0],[0,0,0,0]]],
  "strand":[[0.514,0.485]]
}

設定ファイル

example/pmsignature_minimal/paplot.cfg¶

[pmsignature]
tooltip_format_ref1 = A: {a:.2}
tooltip_format_ref2 = C: {c:.2}
tooltip_format_ref3 = G: {g:.2}
tooltip_format_ref4 = T: {t:.2}
tooltip_format_alt1 = C -> A: {ca:.2}
tooltip_format_alt2 = C -> G: {cg:.2}
tooltip_format_alt3 = C -> T: {ct:.2}
tooltip_format_alt4 = T -> A: {ta:.2}
tooltip_format_alt5 = T -> C: {tc:.2}
tooltip_format_alt6 = T -> G: {tg:.2}
tooltip_format_strand = + {plus:.2} - {minus:.2}

color_A = #06B838
color_C = #609CFF
color_G = #B69D02
color_T = #F6766D
color_plus = #00BEC3
color_minus = #F263E2

[result_format_pmsignature]
format = json
background = True
key_ref = ref
key_alt = alt
key_strand = strand

paplot を実行します。

paplot pmsignature pmsignature_minimal/data.json ./tmp pmsignature_minimal \
--config_file ./pmsignature_minimal/paplot.cfg

上記のコマンドを実行すると以下の場所にレポートが作成されます。

ここで出力されるレポートファイルの名称 graph_pmsignature2.html には pmsignature 数が反映されています。

pmsignature 数は paplot 実行時に入力データ (data.json) から paplot が読み取ります。

./tmp
  ┗ pmsignature_minimal
      ┗ graph_pmsignature2.html

注釈

この例では pmsignature の出力に background を設定しています。そのため、1 つの pmsignature に background signature を割り当てていますので、実際に表示されている pmsignature は 1 つ少ないように見えますがこれで正しい表示です。

3. 複数データファイルの pmsignature¶

このセクションで生成するレポートを見る

pmsignature 2

pmsignature 3

pmsignature 4

pmsignature 5

pmsignature 6

このセクションで使用するデータセットを見る

このセクションで使用するデータセットをダウンロードする

入力データ形式は 1. jsonフォーマット参照。

pmsignature 実行手順の手順でデータの準備を行う場合、設定ファイルの変更は必要ありません。

pmsignature 解析においては、クラスタリング数を 2 や 3 などに固定せず、2 ～ 6 など幅を持たせた数で試験的に解析を行い、結果をみて適切なクラスタ数を決定することが一般的です。

したがって今回のセクションでは、pmsignature のデータファイルを複数使用します。

今回の場合、以下のファイル構成になります。

example/pmsignature_multi_class/

   # データファイル
  ┣ data2.json  # pmsignature num = 2
  ┣ data3.json  # pmsignature num = 3
  ┣ data4.json  # pmsignature num = 4
  ┣ data5.json  # pmsignature num = 5
  ┣ data6.json  # pmsignature num = 6

   # 設定ファイル
  ┗ paplot.cfg

pmsignature のデータファイルごとに paplot を実行します。

paplot pmsignature pmsignature_multi_class/data2.json ./tmp pmsignature_multi_class \
--config_file ./pmsignature_multi_class/paplot.cfg

paplot pmsignature pmsignature_multi_class/data3.json ./tmp pmsignature_multi_class \
--config_file ./pmsignature_multi_class/paplot.cfg

paplot pmsignature pmsignature_multi_class/data4.json ./tmp pmsignature_multi_class \
--config_file ./pmsignature_multi_class/paplot.cfg

paplot pmsignature pmsignature_multi_class/data5.json ./tmp pmsignature_multi_class \
--config_file ./pmsignature_multi_class/paplot.cfg

paplot pmsignature pmsignature_multi_class/data6.json ./tmp pmsignature_multi_class \
--config_file ./pmsignature_multi_class/paplot.cfg

下記のようにまとめて実行することもできます。

paplot pmsignature "pmsignature_multi_class/data*.json" ./tmp pmsignature_multi_class \
--config_file ./pmsignature_multi_class/paplot.cfg

上記のコマンドを実行すると以下の場所にレポートが作成されます。

ここで出力されるレポートファイルの名称 graph_signature2.html には pmsignature 数が反映されています。

pmsignature 数は paplot 実行時に入力データ (data.json) から paplot が読み取ります。

./tmp
  ┗ pmsignature_multi_class
      ┣ graph_pmsignature2.html
      ┣ graph_pmsignature3.html
      ┣ graph_pmsignature4.html
      ┣ graph_pmsignature5.html
      ┗ graph_pmsignature6.html

注釈

この例では pmsignature の出力に background を設定しています。そのため、1 つの pmsignature に background signature を割り当てていますので、実際に表示されている pmsignature は 1 つ少ないように見えますがこれで正しい表示です。

4. 寄与度グラフ¶

このセクションで生成するレポートを見る

pmsignature 2

pmsignature 3

pmsignature 4

pmsignature 5

pmsignature 6

このセクションで使用するデータセットを見る

このセクションで使用するデータセットをダウンロードする

レポートに変異の内訳グラフを追加します。 pmsignature 実行手順の手順でデータの準備を行う場合、あらかじめ出力するように設定しています。

入力データ形式は 1. jsonフォーマット参照。

複数データ実行方法は 3. 複数データファイルの pmsignature 参照。

paplot を実行します。

paplot pmsignature "pmsignature_stack/data*.json" ./tmp pmsignature_stack \
--config_file ./pmsignature_stack/paplot.cfg

注釈

この例では pmsignature の出力に background を設定しているため、実際に出力される pmsignature は 1 少ない数が表示されます。 (寄与度グラフの最後の pmsignature は background シグネチャです)

5. Backgroundなし¶

このセクションで生成するレポートを見る
このセクションで使用するデータセットを見る
このセクションで使用するデータセットをダウンロードする

通常、pmsignature は background ありで作成しますが、background なしで作成することもできます。

手順詳細は pmsignature 実行手順を参照ください。

pmsignature を background なしで作成します。

library(pmsignature)

# use sample data
inputFile <- system.file("extdata/Nik_Zainal_2012.mutationPositionFormat.txt.gz", package="pmsignature")
G <- readMPFile(inputFile, numBases = 5, trDir = TRUE)

# background を使用する場合
# BG_prob <- readBGFile(G)
# Param <- getPMSignature(G, K = 3, BG = BG_prob)
# Boot <- bootPMSignature(G, Param0 = Param, bootNum = 100, BG = BG_prob)

# background を使用しない場合
Param <- getPMSignature(G, K = 3)
Boot <- bootPMSignature(G, Param0 = Param, bootNum = 100)

# save .Rdata
resultForSave <- list(Param, Boot)
save(resultForSave, file="pmsignature_ind3.Rdata")

作成した Rdata を json に変換します。

R --vanilla --slave --args ./pmsignature_ind3.Rdata ./pmsignature_ind3.json < {path to genomon_Rscripts}/pmsignature/convert_toJson_ind.R

設定ファイルで background オプションを False に設定します。

example/pmsignature_nobackground/paplot.cfg¶

[result_format_pmsignature]
background = False

paplot を実行します。

paplot pmsignature pmsignature_nobackground/data.json ./tmp pmsignature_nobackground \
--config_file ./pmsignature_nobackground/paplot.cfg