pacsomatic

pacsomatic

使用する場面

scripts/run_pacsomatic.py を使用して、マッチした PacBio HiFi の腫瘍/正常ペアを 1 組準備し、サンプルシートと再現可能な起動アーティファクトを生成し、ローカルで起動するか、Nextflow ドライバーをスケジューラに投入します。パイプラインは入力 BAM を再アラインメントしますが、このヘルパーはアラインメントされていない HiFi BAM とオプションの PacBio .pbi インデックスを対象としています。ショートリードで代用したり、BAM ファイル名をプラットフォーム、マッチした同一性、またはメチル化情報の証拠として扱ったりしないでください。

レビュー済みの上流 dev コミットは 24c84cb371b0339c1d65a4de9451671945e19772 です。内部マニフェストには 1.0.0 と記載されていますが、2026-10-01 時点で GitHub にはリリースもタグもありませんでした。このヘルパーは nf-core/pacsomatic に対してデフォルトでそのコミットを固定しますが、リリースタグをでっち上げることはありません。これはソースをレビューした開発ワークフローであり、臨床的に検証されたアッセイではありません。出典と科学的なチェックについては references/pacsomatic_guide.md を参照してください。

ワークフロー

1. 異なる腫瘍と正常の BAM パス、患者 ID、異なるサンプル ID、出力ディレクトリ、およびちょうど 1 つの参照モード（--fasta または --genome）を取得します。ID と BAM/PBI/FASTA のパスには空白を含めてはいけません。ローカル入力は空でない通常ファイルでなければなりません。リモートの BAM/PBI/FASTA URI はダウンロードや認証なしでそのまま渡されます。管理されたファイルシステム/クラウドの認証情報を使用し、生成されたファイルにシークレットや署名付き URL を決して埋め込まないでください。
2. 取得メタデータから PacBio HiFi のリードグループとサンプルの同一性を確認し、メチル化に必要な MM/ML 修飾タグが保持されていることを確認します。すべてのアノテーションリソースについて、参照配列/コンティグの互換性を検証します。
3. --dry-run でアーティファクトを生成します。これはヘルパーのチェックを実行してファイルを書き込みますが、パイプラインの呼び出し、BAM 内容の検証、リモートの可用性のチェック、すべてのパイプラインパラメータの解決、生物学的な適合性の検証は行いません。ここでは実行時に不足しているツールは警告となります。--dry-run は --run/--submit、クローニング、または環境作成と組み合わせることはできません。
4. サンプルシート、生成された params YAML、スクリプト、パイプラインリビジョン、プロファイル、およびブランチ固有のリソース/スキップを確認します。既存のアーティファクトには明示的な --overwrite が必要です。入力ファイルをアーティファクトのターゲットにすることは決してできません。config.yaml はオペレーター向けの参照であり、自動的に読み込まれる設定ファイルではありません。
5. 実行するには、--use-current-path または既存の --conda-env で実際のランタイムを選択します。ヘルパーを呼び出す前にクラスターモジュールをロードしてください。--module-load はそれらのコマンドを生成されたスクリプト内で繰り返すだけです。Conda YAML は同梱されていません。環境を作成するには --conda-env-file が明示的に必要です。
6. --run は要求された実行にのみ使用します。HPC では、外側のランチャースケジューラ（--executor）と、サイトプロファイルまたは --nextflow-config で構成される Nextflow のタスク単位の process.executor を区別してください。ドライバーの CPU/メモリ要求はタスクのリソースを制約しません。references/config-and-output.md をお読みください。
7. アーティファクトのパス、リビジョン、チェック/警告、実行タイプ、存在する場合は投入 ID、および具体的な次の QC または障害トリアージのステップを報告します。スケジューラによる受理はパイプラインの完了ではありません。--resume のために出力ディレクトリと work/キャッシュの状態を安定に保ってください。スクリプトは出力ディレクトリを cwd として実行されます。

例

これらはリポジトリのルートから実行してください。パスとサイト設定は例示であり、 ローカルテストでは合成のプレースホルダーのみを使用し、ヒトゲノムデータは使用しません。

python skills/pacsomatic/scripts/run_pacsomatic.py \
  --tumor-bam /data/P001_T.bam --normal-bam /data/P001_N.bam \
  --patient-id P001 --tumor-sample-id P001_T --normal-sample-id P001_N \
  --outdir /results/P001 --fasta /refs/GRCh38.fa \
  --profile apptainer --use-current-path --dry-run

成果物を確認した後、Slurm の起動では同じ入力を使用し、さらに 以下のオプションを指定できます（--dry-run を --run に置き換えてください）:

--executor slurm --queue compute --project my_account
--cpus 2 --memory-gb 8 --walltime 48:00
--nextflow-config /configs/slurm.config --overwrite --run

これらのリソースはドライバー用であり、確認済みのインフラストラクチャ設定で process.executor = 'slurm' および適切なタスクキュー/リソースが設定されていることを前提としています。ヘルパーは 48:00 を Slurm の 48:00:00（48 時間）に正規化します。実際にその機関の LSF インフラストラクチャを使用する場合を除き、sanger プロファイルを追加しないでください。

カスタムパイプラインパラメーターは --params-file に、インフラストラクチャは --nextflow-config（-c）に指定します。ヘルパーの明示的な input/outdir/reference オプションは params-file の値よりも優先されます。--extra-args はトークン化されシェルクォートされますが、 これらの管理対象の入力/設定オプションを上書きすることはできません。ランチャーの cwd は outdir であるため、外部の params/config ファイル内のパスは絶対パスのままにしてください。

検証とリファレンス

uv run skills-ref validate skills/pacsomatic
python tests/run_all.py --isolated pacsomatic

標準ライブラリのスイートは、ローカル成果物の動作、パス保護、 CLI モード、ランタイム障害、およびモックされたスケジューラー送信をチェックします。ネイティブの Nextflow チェックでは小さなローカルワークフローを使用しますが、pacsomatic の完全な コンテナ化されたサイエンティフィックパイプラインが特定のデータセットやクラスターで成功することは証明しません。

• オペレータープレイブック
• 設定、スケジューラー、出力のコントラクト
• アップストリームソースとサイエンティフィックチェック