dataset_feature_search
Search dataset features by feature ID, m/z, or retention time, or match target compounds by InChIKey and adduct rules to resolve annotated candidates (read-only).
Instructions
DatasetState の特徴を探し、目的の物質に当たる特徴を規則で判定する(読み取り専用)。
2 つの使い方があり、targets の有無で切り替わる(同時指定は DATASET_BAD_REQUEST)。
窓検索(targets なし): feature_ids(SMF_ID の完全一致)・min_mz/max_mz・
min_rt/max_rt(分)の AND。境界を含む。何も指定しなければ FEATURE_SEARCH_EMPTY_QUERY
(全件を返さない)。feature_ids=[] は「どの ID でもない」条件で 0 件。並びは m/z 昇順。
戻り値 features は TSV(feature_id mz rt evidence name inchikey adduct n_sme。
evidence は sme/sml/none)。注釈の無い特徴にも統計を付ける。
目標照合(targets あり、1 回 50 件まで): 各要素は target_id・inchikey(必須。
先頭 14 文字で照合)と、formula か(expected_mz と adduct)。任意で name ppm
(既定 10)rt_min rt_tol_min(既定 0.3)adduct_tiers polarity。付加体の層を上から、
証拠の水準 sme_match → sml_match → unannotated の順に見て、qualified がちょうど 1 つの
ときだけ resolved。2 つ以上なら needs_input(multiple_qualified_candidates)、無ければ
needs_input(no_qualified_candidate)。強度・ppm・RT の近さでは選ばない。
unannotated は rt_min があるときだけ qualified。SME(MS/MS 同定)が別物質なら落とす。
極性はジョブの宣言 → mzTab-M の付加体の多数決の順に決め、rule.polarity_source に書く。
目標の極性は polarity、省けば明示した付加体(adduct/adduct_tiers)の符号で、
データセットと違う目標は not_applicable(陽陰が混ざる付加体は FEATURE_TARGET_INVALID)。
戻り値 targets(目標ごとの判定と段ごとの件数)・candidates(TSV。目標ごとに
max_results 件まで)・rule(正規化した規則と rule_hash。result_id・表示名 name・
目標の並び順を含まないので、同じ目標・同じ極性なら別の session でも同じ hash)。hash は表示用の丸め(理論 m/z を
4 桁に)より前の値から作るので、返された rule.targets から計算し直すことはできない
——照合は rule_hash の値どうしで行う。
result_ids: 統計を付ける 2 群比較(dataset_differential)の結果。省略時は今も有効な
2 群比較の全部(古いものは使わず notes に挙げる)。名指しした ID が無い・古いときは
missing_state。差次的結果が 1 件も無ければ統計なしで返す。
max_results: 窓検索の行数・目標ごとの候補数の上限(既定 20)。打ち切りは notes に書く。
stats は TSV(feature_id result_id status log2fc p q mean_a mean_b detected_a detected_b)。
status は tested / not_in_matrix(前処理で落ちた)/ not_testable(p が無い)で、
後の 2 つは数値欄が空(「差が無かった」ではない)。detected_* は群ごとの実検出例数
(gap-fill を数えない。検出状態が無ければ空)。results に BH の母集団
(bh_population)と caveat。キュレーションのフラグは反映しない(あれば notes)。
欄の意味は lipidmix://docs/output-format/mztab。
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| max_mz | No | ||
| max_rt | No | ||
| min_mz | No | ||
| min_rt | No | ||
| targets | No | ||
| result_ids | No | ||
| feature_ids | No | ||
| max_results | No |