metagraphダウンロード - metagraphソースコードのダウンロード

metagraph

その他のソースコード

Version 0.3.6

ダウンロード

メタゲノムグラフプロジェクト

MetaGraph は、注釈付きゲノムグラフのスケーラブルな構築と配列とグラフのアライメントのためのツールです。

MetaGraph のデフォルトのインデックス表現は非常にスケーラブルで、数兆のノードと数百万の注釈ラベルを含むグラフの構築をサポートします。同時に、提供されるワークフローとその慎重な実装は、コアデータ構造の低レベルの最適化と組み合わされて、優れたクエリとアライメントのパフォーマンスを可能にします。

主な特徴:

シーケンスの大規模なインデックス作成
サーバーモードでクエリを実行するための Python API
ソース配列内のk-mer 数(例、発現値) およびk-mer 座標のエンコード (ゲノムのロスレスエンコードなど)
非常に大きな注釈付きグラフに対するシーケンスのアライメント(sub-k シードにより、任意の短いシードを使用できます)
非常に大きな de Bruijn グラフのスケーラブルなクリーニング (順序付けエラーを除去するため)
カスタムアルファベットのサポート (例: {A、C、G、T、N} またはアミノ酸)
ディファレンシャルアセンブリのアルゴリズム

MetaGraph での設計の選択肢:

非常に高いスケーラビリティを実現する簡潔なデータ構造と効率的な表現スキームの使用
簡潔なデータ構造で効率的に機能するアルゴリズムの選択 (例: 常にバッチ処理を優先する)
さまざまなグラフと注釈表現のモジュール式サポート
汎用的で拡張可能なインターフェイスを使用して、コードのオーバーヘッドをほとんど発生させずにカスタムインデックス表現/アルゴリズムの追加をサポートします。

ドキュメント

オンラインドキュメントは https://metagraph.ethz.ch/static/docs/index.html で入手できます。オフラインのソースはここにあります。

インストール

コンダ

Anaconda を使用して最新リリースを Linux または Mac OS X にインストールします。

 conda install -c bioconda -c conda-forge metagraph

ドッカー

システム上で docker が利用可能な場合は、すぐに開始してください。

 docker pull ghcr.io/ratschlab/metagraph:master
docker run -v ${HOME}:/mnt ghcr.io/ratschlab/metagraph:master 
    build -v -k 10 -o /mnt/transcripts_1000 /mnt/transcripts_1000.fa

${HOME}をホストシステム上のディレクトリに置き換えて、コンテナ内の/mntの下にマップします。

Proteinアルファベット用にコンパイルされたバイナリを実行するには、 --entrypoint metagraph_Proteinを追加するだけです。

 docker run -v ${HOME}:/mnt --entrypoint metagraph_Protein ghcr.io/ratschlab/metagraph:master 
    build -v -k 10 -o /mnt/graph /mnt/protein.fa

ご覧のとおり、Docker コンテナから MetaGraph を実行するのは非常に簡単です。また、次のコマンド (または同様のコマンド) は、コンテナーにマウントされているディレクトリを確認したり、コマンドの他の種類のデバッグを行うのに便利です。

 docker run -v ${HOME}:/mnt --entrypoint ls ghcr.io/ratschlab/metagraph:master /mnt

コンテナーイメージのさまざまなバージョンがすべてここにリストされます。

ソースからインストールする

ソースからコンパイルするには (たとえば、カスタムアルファベットまたはその他の構成を使用したビルドの場合)、オンラインのドキュメントを参照してください。

一般的なワークフロー

Fasta ファイル、FastQ ファイル、または KMC k-mer カウンターから de Bruijn グラフを構築します。
./metagraph build
列圧縮された注釈を使用してグラフに注釈を付けます。
./metagraph annotate
構築されたアノテーションを別のアノテーションスキームに変換します。
./metagraph transform_anno
注釈付きグラフのクエリ
./metagraph query

例

 DATA="../tests/data/transcripts_1000.fa"

./metagraph build -k 12 -o transcripts_1000 $DATA

./metagraph annotate -i transcripts_1000.dbg --anno-filename -o transcripts_1000 $DATA

./metagraph query -i transcripts_1000.dbg -a transcripts_1000.column.annodbg $DATA

./metagraph stats -a transcripts_1000.column.annodbg transcripts_1000.dbg

印刷の使用法

./metagraph

グラフの構築

シンプルなビルド

./metagraph build -v --parallel 30 -k 20 --mem-cap-gb 10 
                        -o < GRAPH_DIR > /graph < DATA_DIR > / * .fasta.gz 
2>&1 | tee < LOG_DIR > /log.txt

ディスクスワップを使用してビルドする (RAM の使用量を制限するために使用)

./metagraph build -v --parallel 30 -k 20 --mem-cap-gb 10 --disk-swap < GRAPH_DIR > 
                        -o < GRAPH_DIR > /graph < DATA_DIR > / * .fasta.gz 
2>&1 | tee < LOG_DIR > /log.txt

KMC でフィルタリングされた k-mer から構築

K=20
./KMC/kmc -ci5 -t4 -k $K -m5 -fm < FILE > .fasta.gz < FILE > .cutoff_5 ./KMC
./metagraph build -v -p 4 -k $K --mem-cap-gb 10 -o graph < FILE > .cutoff_5.kmc_pre

グラフに注釈を付ける

./metagraph annotate -v --anno-type row --fasta-anno 
                           -i primates.dbg 
                           -o primates 
                           ~ /fasta_zurich/refs_chimpanzee_primates.fa

注釈を Multi-BRWT に変換する

クラスター列

./metagraph transform_anno -v --linkage --greedy 
                           -o linkage.txt 
                           --subsample R 
                           -p NCORES 
                           primates.column.annodbg

N*R/8 + 6*N^2バイトの RAM が必要です。ここで、 Nは列数、 Rサブサンプリングされた行数です。

マルチ BRWT の構築

./metagraph transform_anno -v -p NCORES --anno-type brwt 
                           --linkage-file linkage.txt 
                           -o primates 
                           --parallel-nodes V 
                           -p NCORES 
                           primates.column.annodbg

M*V/8 + Size(BRWT)バイトの RAM が必要です。ここで、 Mは注釈内の行数、 V同時にマージされるノードの数です。

クエリグラフ

./metagraph query -v -i < GRAPH_DIR > /graph.dbg 
                        -a < GRAPH_DIR > /annotation.column.annodbg 
                        --min-kmers-fraction-label 0.8 --labels-delimiter " , " 
                        query_seq.fa

グラフに揃える

./metagraph align -v -i < GRAPH_DIR > /graph.dbg query_seq.fa

シーケンスを組み立てる

./metagraph assemble -v < GRAPH_DIR > /graph.dbg 
                        -o assembled.fa 
                        --unitigs

差分シーケンスを組み立てる

./metagraph assemble -v < GRAPH_DIR > /graph.dbg 
                        --unitigs 
                        -a < GRAPH_DIR > /annotation.column.annodbg 
                        --diff-assembly-rules diff_assembly_rules.json 
                        -o diff_assembled.fa

サンプルファイルについては、 metagraph/tests/data/example.diff.jsonおよびmetagraph/tests/data/example_simple.diff.jsonを参照してください。

統計を取得する

グラフの統計

./metagraph stats graph.dbg

アノテーションの統計

./metagraph stats -a annotation.column.annodbg

両方の統計

./metagraph stats -a annotation.column.annodbg graph.dbg

開発者向けノート

メイクファイル

最上位のソースディレクトリ内のMakefile使用すると、 metagraphの構築とテストをより簡単に行うことができます。次の引数がサポートされています。

env : コンパイル/実行する環境 ( "" : ホスト上、 docker : Docker コンテナ内)
alphabet : 特定のアルファベットのメタグラフをコンパイルします (例: DNAまたはProtein 、デフォルトのDNA )
additional_cmake_args : cmake に渡す追加の引数。

例:

 # compiles metagraph in a docker container for the `DNA` alphabet
make build-metagraph env=docker alphabet=DNA

新しいリリースを更新して作成する

新しいバージョンリリースの作成は、次の 3 つの手順で行われます。

package.jsonを更新してバージョンを設定する
新しいバージョンのタグを追加します
github で新しいリリースを作成する

ライセンス

Metagraph は GPLv3 ライセンスに基づいて配布されます (「ライセンス」を参照)。詳細については、AUTHORS ファイルと COPYRIGHTS ファイルをご覧ください。

拡大する

追加情報

バージョン Version 0.3.6
タイプその他のソースコード
更新時間 2024-12-25
サイズ 43.67MB
から Github

metagraph