アメリエフのブログ

Amelieff Staff Blog

ツールの出力をまとめてレポートに! MultiQC ②

前回に引き続きMultiQCの実装を行います。

必要環境

適当なブラウザ (Chrome, Firefox, Safari)
今回は仮想環境を入れて実装するのでOSは何でもよいです。

事前準備

minicondaを入れましょう。 詳しくはググりましょう。親切な方が紹介しています。

インストール

MultiQCはPython2系で動作します。
2系の仮想環境を作って、仮想環境を立ち上げましょう。

conda create --name py2.7 python=2.7
source activate py2.7
# Windowsの場合: activate py2.7

multiQCのインストール

conda install -c bioconda multiqc

実行

multiqc data/*_fastqc.zip ../proj_one/analysis /tmp/results

引数で渡したディレクトリ内を検索し、multiQCが対応しているツールのログファイルまたは結果ファイルを見つけるとレポートの内容に取り込みます。 正規表現を使うことも可能です。

ファイルで検索したいディレクトリの一覧を渡すこともできます。その場合は、以下のように、対象としたいファイルパスを羅列したファイルを作成し、

data/*_fastqc.zip
data/ ../proj_one/analysis
/tmp/results

その後、--file-listで上記ファイルを指定して実行すれば良いだけです。

multiqc --file-list my_file_list.txt

結果の閲覧

image.png (187.9 kB)

Macなら

open multiqc_report.html

Linuxなら

firefox multiqc_report.html

とかでhtmlが見れます。Windowsの方は普通にクリックすればいけるはずです。

できることざっと

このレポートの何が素晴らしいかを実際の画像とともにざっと説明してゆきます

ソート

image.png (14.6 kB)

リードのアライメント率やマッピング率でソートができます。

インタラクティブ

image.png (66.9 kB)

レポート中のFigureはインタラクティブなものになっています。
つまりはマウスでクリックやドラッグすることで拡大縮小したり、気になる情報を詳細に見ることができます。
これは黒い画面が怖い人にとってはとっても嬉しいですね。

ブラウザから任意に出力

image.png (2.2 kB)

レポート中の任意のFigureをワンクリックで出力できます。

表記の切り替え

image.png (3.7 kB)

プロット中でリード数で表記するか、パーセンタイルで表記するかを切り替えられます。

ハイライト

image.png (83.9 kB)

気になるサンプルをハイライトすることもできます。

オプション

PDFで出力したい!

--pdfを付けるだけです。

プロットされた画像ファイルがほしい!

-p/--export を付けるだけです。

実行したディレクトリ以下にmultiqc_plotsというディレクトリが作られて、その中に画像ファイル (.png, .svg , .pdf)が出力されます。

違うフォーマットで出力したい

default, default_dev, geo, simple, sectionsの5種類から選べます。
-t/--templateで指定します。

オプションをファイルから指定したい

-c/--configでconfigファイルを指定しましょう。
configファイルはyaml形式で書きます。
詳しくは以下を参照。
http://multiqc.info/docs/#configuring-multiqc

configファイルの具体例はここ

感想

凄まじいです。サンプル数が多いときなんかにも大活躍しそうです。

できることが多いにも関わらず、ドキュメントがわかりやすいので簡単に機能を試せます。
出力にかかる時間もファイルを指定すれば、かなり短いです。
ぜひお試しを!