クイックスタート

このセクションでは以下の内容について解説します。

  1. paplot をインストール
  2. サンプルデータでコマンドを実行
  3. 結果ファイルを表示
  4. 設定ファイルを編集して自分のデータを使用する

1. paplot をインストール

paplot は python2.7 および python 3.5 で動作確認しています。
また、paplot は追加パッケージを必要としません。
より詳しいインストール手順は インストール を参照してください。
cd {インストールしたいディレクトリ}
# v0.5.4 の場合
wget https://github.com/Genomon-Project/paplot/archive/v0.5.4.zip
unzip v0.5.4.zip
cd paplot-0.5.4/

python setup.py build install
正しくインストールされたか確認します。

インストールの確認

以下を入力してください。
paplot --version
このように表示されればインストール成功です。(インストールしたバージョンが表示されます)
paplot-0.5.4

2. サンプルデータでコマンドを実行

paplot はコマンドから使用します。

基本的な使い方は次の通りです。
詳細なオプションは paplot コマンド を参照してください。
paplot subcommand [--config_file CONFIG_FILE] [--title TITLE]
                  [--ellipsis ELLIPSIS] [--overview OVERVIEW]
                  [--remarks REMARKS]
                  input output_dir project_name

必ず入力する項目

subcommand:

paplot のサブコマンドです。いずれかを選択します。

  • qc
  • ca
  • mutation
  • signature
  • pmsignature
input:

入力ファイルです。

output_dir:

出力ディレクトリを指定します。ディレクトリ構成は次の章を参照してください。

project_name:

プロジェクト名です。出力ファイルのタイトルに使用します。

サンプルデータを用意していますので実行します。

cd {paplot を解凍したディレクトリ}

# QC レポート
paplot qc example/qc_brush/data.csv ./tmp demo

# Chromosomal Aberration レポート
paplot ca example/ca_option/data.csv ./tmp demo

# Mutation Matrix レポート
paplot mutation example/mutation_option/data.csv ./tmp demo

# Mutational Signatureレポート
paplot signature "example/signature_stack/data*.json" ./tmp demo

# pmsignature レポート
paplot pmsignature "example/pmsignature_stack/data*.json" ./tmp demo

3. 結果ファイルを表示

HTML ファイルができていますか?

{output_dir} で指定したディレクトリ
   demo
      graph_ca.html            <--- Chromosomal Aberration レポート
      graph_mut.html           <--- Mutation Matrix レポート
      graph_pmsignature2.html  <--- pmsignature レポート (数字は変異シグネチャの数)
      graph_pmsignature3.html
      graph_pmsignature4.html
      graph_pmsignature5.html
      graph_pmsignature6.html
      graph_qc.html            <--- QC レポート
      graph_signature2.html    <--- Mutational Signature レポート (数字は変異シグネチャの数)
      graph_signature3.html
      graph_signature4.html
      graph_signature5.html
      graph_signature6.html
     js          <--- この4つのディレクトリはHTMLファイルを表示するために必要です。消さないでください。
   layout
   lib
   style
     index.html             <--- このファイルをウェブブラウザで開いてください。
index.html ファイルをウェブブラウザで開いてください。

注釈

HGC スパコン等、サーバ上で実行した場合はファイルをローカルに転送するか、NoMachime 等サーバ上の仮想ウィンドウで表示してください。 ローカルに転送する場合は、tmp ディレクトリを丸ごとコピーしてください。

次のように見えていますか?

QC レポート
_images/qc_dummy.PNG
Chromosomal Aberration レポート
_images/sv_dummy.PNG
Mutation Matrix レポート
_images/mut_dummy.PNG
Mutational Signature レポート
_images/sig_dummy.PNG
pmsignature レポート
_images/pmsig_dummy.PNG
それぞれのレポートの使い方は HOW TO USE GRAPHS を参照してください。
データと設定ファイルの記述方法は以下を参照してください。

[入門編]
[上級者向け]