pipeline_plan
Validate and resolve MS-DIAL pipeline request settings, save missing inputs or fixed requirements, and confirm execution conditions without launching analysis.
Instructions
入力検査・不足情報・固定要求の保存のみを行う。Consoleは起動しない。
Parameters
dataset_root:
生データフォルダのパス。MS-DIAL が読む 12 形式
(.abf / .ibf / .cdf / .mzml / .wiff / .raw / .d / .wiff2 /
.qgd / .lcd / .lrp / .imzml)が入っているフォルダを指します。
Agilent・Bruker の .d と Waters の .raw はフォルダが 1 検体です。
request:
pipeline-request.v1 のトップレベル項目(省略可、spec §10.1)。
target / polarity / method_file / lbm_file / library_mode /
msp_file / sample_manifest / preprocess / comparisons 等。相対パスは
dataset_root 基準。library_mode="msp_only" は LBM を使わず研究室の参照
ライブラリ(.msp)だけで同定する(msp_file か極性の設定 [library] msp_positive / msp_negative。メソッドの Text DB・注釈器設定表の宣言は空にする)。
lbm_file との同時指定、auto での msp_file は PIPELINE_REQUEST_INVALID。
request_id:
冪等性キー。同一内容の再送は同じ結果を返し、別内容は IDEMPOTENCY_CONFLICT。
dataset_root 直下に analysis-request.json(同じトップレベル項目を持つ
JSON)と sample-manifest.tsv があれば既定名として読む。要求値の優先順位は
request で明示した値 > analysis-request.json > 既定値(spec §7.1)で、
preprocess だけは子キー単位で重なる。どの値がどこから来たかは保存された
要求の value_sources(explicit / request_file / default)で確認できる。
置いてあるファイルが壊れている・未知キーを持つ場合は黙って無視せず
PIPELINE_REQUEST_INVALID にする。
receiptの resolved に、解決済みの実行条件——method(source_path /
sha256)・lbm・polarity(value とその source)・library_mode・
msp(ファイル名・sha256・出どころ。置き場所は載せない)——が入る。何も
起動しないうちにこれらを確認するのがこのツールの用途。
起動せずに needs_input を保存することがある(不正なsample_manifest等、
spec §9.2「既知の不正入力はConsole起動前に拒否する」)。条件だけ確認したい
利用者はこちらを使い、実際に進めたいときは pipeline_run を使う。
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| request | No | ||
| request_id | No | ||
| dataset_root | Yes |