URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты VariantAlleleFractionGateChecker для сценария Variant Allele Fraction Gate Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- • LOD/LOQ Comparison: Сравнение наблюдаемой VAF с валидированными пределами обнаружения и количественного определения.
- • Purity-Adjusted Expectation: Корректировка ожидаемой минимальной VAF на чистоту опухоли и плоидность.
- • Germline Suspicion Flag: Выявление вариантов с VAF ~50%/~100% в соматических образцах.
- ⚠️ ВАЖНО:
- • Binomial p-value > 0.05 означает, что alt reads могут быть объяснены ошибкой секвенирования.
- SampleID,VariantID,Gene,VariantType,Context,ObservedVAF_Percent,TotalDepth,AltReads,TumorPurity_Percent,Ploidy,AssayLOD_Percent,AssayLOQ_Percent,ExpectedMinVAF_PurityAdjusted,BinomialPValue,MaxBinomialPValue,IsKnownHotspot,HasStrandBias,IsInHomopolymer,GnomAD_AF,IsGermlineByVAF
- TUMOR-001,KRAS:c.35G>A,KRAS,SNV,Somatic_Tissue,8.5,450,38,20,2.0,5.0,10.0,7.5,1.2E-12,0.05,true,false,false,0.00001,false
- • Жидкая биопсия: Валидация ultra-rare вариантов (VAF <1%) в cfDNA.
- • MRD-мониторинг: Разграничение истинного сигнала от шума на пределе чувствительности.
- Это критически важно для чувствительности жидкой биопсии и специфичности тканевого тестирования.
- ⚠️ КРИТИЧЕСКИ ВАЖНО:
- • Purity Adjustment: ОБЯЗАТЕЛЬНА для тканевых соматических образцов. Без неё = систематическая потеря вариантов.
- • Binomial P ≤ 0.05: Без статистической значимости VAF бессмысленна независимо от абсолютного значения.
- • Alt Reads ≥ 3: Абсолютный минимум для любого вызова. 1-2 рида = артефакт.
- • Germline Suspicion: VAF ~50% в соматическом образце требует проверки с парной нормалью.
- Критические параметры:
- • Purity-Adjusted Expected VAF: Calculated per sample
- • Binomial P-Value: ≤ 0.05
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для Variant Allele Fraction Gate Checker с заголовками, определёнными в контракте данных. | High | Файл обрабатывается без ручного изменения заголовков. |
| URS-002 | Утилита должна выполнять детерминированную оценку QC/ОКК без машинного обучения и без вероятностного принятия решения о соответствии. | High | При одинаковых входных данных, версии правил и конфигурации результат полностью воспроизводим. |
| URS-003 | Утилита должна валидировать обязательные поля, типы данных, диапазоны, единицы измерения и предметную правдоподобность значений. | High | Ошибки схемы, преобразования и диапазона явно отражаются в результате. |
| URS-004 | Утилита должна применять предметные пределы и правила из описания, утверждённой спецификации, регистрационного досье и локальных SOP. | High | Каждая проверка имеет результат PASS/WARNING/FAIL и понятное сообщение. |
| URS-005 | Утилита должна формировать output.json с машинно-читаемыми результатами, исходными значениями, предупреждениями, отказами и критическими находками. | High | JSON пригоден для LIMS/ELN/MES-интеграции и QA/QC review. |
| URS-006 | Утилита должна сохранять трассируемость между серией/образцом, входным файлом, применёнными правилами и итоговым статусом. | High | Выход содержит идентификаторы, список параметров и audit metadata. |
| URS-007 | Документация должна поддерживать подготовку IQ/OQ/PQ, CSV/CSA и обсуждение с инспекторами или внутренним QA. | Medium | URS, FS, контракт input/output и тестовые сценарии поставляются вместе с утилитой. |
| URS-008 | Утилита должна использоваться как decision-support инструмент QC, а не как замена утверждённым спецификациям и выпускному решению Qualified Person/QA. | Medium | В документации указан контроль change control и необходимость сверки пределов. |
Контракт input.csv
| # | Поле | Тип | Пример | Назначение |
|---|
| 1 | SampleID | string / controlled vocabulary | TUMOR-001 | Идентификатор образца или лабораторной пробы. |
| 2 | VariantID | string / controlled vocabulary | KRAS:c.35G>A | Контролируемый входной параметр для детерминированных QC-правил. |
| 3 | Gene | string / controlled vocabulary | KRAS | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | VariantType | string / controlled vocabulary | SNV | Контролируемый входной параметр для детерминированных QC-правил. |
| 5 | Context | string / controlled vocabulary | Somatic_Tissue | Контролируемый входной параметр для детерминированных QC-правил. |
| 6 | ObservedVAF_Percent | decimal | 8.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 7 | TotalDepth | decimal | 450 | Контролируемый входной параметр для детерминированных QC-правил. |
| 8 | AltReads | decimal | 38 | Контролируемый входной параметр для детерминированных QC-правил. |
| 9 | TumorPurity_Percent | decimal | 20 | Чистота/профиль примесей; ключевой QC-параметр. |
| 10 | Ploidy | string / controlled vocabulary | 2.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 11 | AssayLOD_Percent | decimal | 5.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | AssayLOQ_Percent | decimal | 10.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 13 | ExpectedMinVAF_PurityAdjusted | decimal | 7.5 | Чистота/профиль примесей; ключевой QC-параметр. |
| 14 | BinomialPValue | decimal | 1.2E-12 | Контролируемый входной параметр для детерминированных QC-правил. |
| 15 | MaxBinomialPValue | decimal | 0.05 | Контролируемый входной параметр для детерминированных QC-правил. |
| 16 | IsKnownHotspot | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 17 | HasStrandBias | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 18 | IsInHomopolymer | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 19 | GnomAD_AF | decimal | 0.00001 | Контролируемый входной параметр для детерминированных QC-правил. |
| 20 | IsGermlineByVAF | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
SampleID,VariantID,Gene,VariantType,Context,ObservedVAF_Percent,TotalDepth,AltReads,TumorPurity_Percent,Ploidy,AssayLOD_Percent,AssayLOQ_Percent,ExpectedMinVAF_PurityAdjusted,BinomialPValue,MaxBinomialPValue,IsKnownHotspot,HasStrandBias,IsInHomopolymer,GnomAD_AF,IsGermlineByVAF
TUMOR-001,KRAS:c.35G>A,KRAS,SNV,Somatic_Tissue,8.5,450,38,20,2.0,5.0,10.0,7.5,1.2E-12,0.05,true,false,false,0.00001,false
LB-001,EGFR:c.2573T>G,EGFR,SNV,Somatic_LiquidBiopsy,0.25,25000,62,100,2.0,0.5,1.0,0.5,3.5E-8,0.05,true,false,false,0.0,false
TUMOR-002,PTEN:c.388C>T,PTEN,Indel,Somatic_Tissue,6.2,180,11,45,2.0,5.0,10.0,18.0,0.08,0.05,false,true,true,0.0001,false
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | SampleID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | VariantID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | Gene | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | VariantType | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | Context | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | ObservedVAF_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | TotalDepth | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | AltReads | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | TumorPurity_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | Ploidy | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | AssayLOD_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | AssayLOQ_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | ExpectedMinVAF_PurityAdjusted | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | BinomialPValue | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | MaxBinomialPValue | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | IsKnownHotspot | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | HasStrandBias | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | IsInHomopolymer | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | GnomAD_AF | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-020 | IsGermlineByVAF | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
FS — функциональная спецификация
| ID | Функция | Реализация |
|---|
| FS-001 | CLI execution | Поддержать режимы запуска: demo mode без аргументов и production mode input.csv output.json. |
| FS-002 | CSV import | Прочитать input.csv в UTF-8/CSV-совместимом формате, проверить наличие заголовка и ожидаемых колонок. |
| FS-003 | Schema validation | Проверить обязательные поля, количество колонок, неизвестные ключевые поля и пустые обязательные значения. |
| FS-004 | Type conversion | Преобразовать числовые, флаговые и текстовые значения; некорректный формат фиксировать как ошибку строки. |
| FS-005 | Domain rule engine | Применить правила для Variant Allele Fraction Gate Checker, включая критические пределы из описания и утверждённой спецификации. |
| FS-006 | Status aggregation | Сформировать итоговый статус: FAIL при критическом отказе, WARNING при некритическом отклонении, PASS при соответствии. |
| FS-007 | JSON export | Записать output.json с детализацией проверок, исходными значениями, предупреждениями, отказами и critical findings. |
| FS-008 | Audit support | Сохранять структуру результата пригодной для review, расследования отклонений и воспроизведения расчёта. |
| FS-009 | Integration contract | Поддержать сценарий LIMS/ELN/MES → input.csv → utility → output.json → portal/admin review. |
| FS-010 | Error handling | Возвращать явные сообщения для отсутствующего файла, пустого CSV, неверной схемы, ошибки записи output.json и некорректного формата. |
Пример output.json
{
"utilityId": "variantallelefractiongatechecker",
"utilityFolder": "VariantAlleleFractionGateChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "SampleID",
"value": "TUMOR-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "VariantID",
"value": "KRAS:c.35G>A",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "Gene",
"value": "KRAS",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "VariantType",
"value": "SNV",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "Context",
"value": "Somatic_Tissue",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "ObservedVAF_Percent",
"value": "8.5",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "TotalDepth",
"value": "450",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "AltReads",
"value": "38",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "TumorPurity_Percent",
"value": "20",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "Ploidy",
"value": "2.0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "AssayLOD_Percent",
"value": "5.0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "AssayLOQ_Percent",
"value": "10.0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-012"
}
],
"criticalFindings": [],
"warnings": [],
"audit": {
"inputHash": "sha256:<calculated at runtime>",
"rulesVersion": "<utility executable version>",
"documentation": "VariantAlleleFractionGateChecker.documentation.html"
}
}
Матрица трассируемости
| URS | FS | Тест | Подтверждение |
|---|
| URS-001 | FS-001, FS-002 | OQ-001 | Проверить запуск и импорт валидного input.csv. |
| URS-002 | FS-005, FS-006 | OQ-004 | Повторить один и тот же набор данных и сравнить output.json. |
| URS-003 | FS-003, FS-004, FS-010 | OQ-002, OQ-003 | Проверить отсутствующие колонки и неверные типы. |
| URS-004 | FS-005, FS-006 | OQ-004, PQ-001 | Проверить критические отклонения по реальным/граничным данным. |
| URS-005 | FS-007, FS-009 | OQ-005 | Проверить JSON schema и пригодность для downstream-систем. |
| URS-006 | FS-008 | OQ-006 | Проверить наличие идентификаторов и audit metadata. |
| URS-007 | FS-008, FS-010 | IQ-001, OQ-007 | Проверить комплектность документации и control evidence. |
| URS-008 | FS-005, FS-008 | PQ-002 | Проверить review workflow и запрет автоматической замены QA-решения. |
IQ/OQ/PQ тестовые сценарии
| ID | Сценарий | Ожидаемый результат |
|---|
| IQ-001 | Проверить наличие executable, input.csv, документации и контрольной суммы. | Комплект поставки полон; версия зафиксирована. |
| OQ-001 | Валидная строка из примера input.csv. | PASS или допустимый WARNING согласно правилам. |
| OQ-002 | Удалить обязательную колонку из CSV. | Ошибка схемы или FAIL с указанием отсутствующей колонки. |
| OQ-003 | Внести нечисловое значение в числовое поле. | Ошибка преобразования типа с указанием строки/поля. |
| OQ-004 | Значение критического параметра вывести за предел. | FAIL и critical finding. |
| OQ-005 | Проверить структуру output.json. | Все обязательные секции присутствуют, JSON валиден. |
| OQ-006 | Проверить трассируемость серии/образца. | Идентификаторы входа и результатов совпадают. |
| PQ-001 | Проверить 3–5 реальных партий/образцов пользователя. | Результат подтверждён QC/QA review. |
| PQ-002 | Проверить workflow отклонения и ручного QA-решения. | Утилита поддерживает review, но не заменяет утверждённое решение. |
QA/QC и change control
- Не менять имена колонок без обновления валидатора, документации и тестового набора.
- Хранить
input.csv, output.json, версию исполняемого файла и контрольную сумму. - Перед продуктивным использованием провести IQ/OQ/PQ или эквивалентную CSV/CSA-проверку.
- Критические пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- Утилита предоставляет формализованный QC decision support, но окончательное решение выпуска остаётся за QA/QP и утверждёнными процедурами.