URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты LowVafSignalGateChecker для сценария Low VAF Signal Gate Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- Low VAF Signal Gate Checker — Многофакторная валидация вызовов с VAF < 1%
- • Min UMI Families ≥ 3: Минимум 3 независимых молекулярных семейства для подтверждения.
- • Mean Family Size ≥ 3.0: Достаточный размер семейства для консенсусного подавления ошибок.
- • Strand Balance Ratio ≥ 0.3: Отношение min(F,R)/max(F,R). Ниже = односторонний артефакт.
- • Binomial P-Value ≤ 0.01: Вероятность наблюдения alt reads при нулевой гипотезе (шум).
- • Mapping Quality ≥ 40: Однозначное выравнивание прочтений.
- • Base Quality ≥ 25: Достоверность определения основания.
- • Background Noise at Position ≤ 0.1% VAF: Локальный шум не должен превышать сигнал.
- • gnomAD Filter: AF > 1% = вероятный герминальный полиморфизм.
- ⚠️ ВАЖНО:
- • При VAF < 1% НЕ СУЩЕСТВУЕТ надежных вызовов без UMI.
- • Binomial p-value не заменяет UMI-подтверждение; оба критерия обязательны.
- 1. UMI Design: Используйте UMI ≥ 8 nt и двойные UMI для минимизации коллизий.
- 2. PoN Construction: Стройте PoN из ≥ 40 нормальных образцов, обработанных идентично.
- 4. Manual Review Protocol: Определите четкие критерии для REVIEW_REQUIRED случаев.
- 5. Orthogonal Confirmation: Для клинически значимых вызовов при VAF < 0.5% подтверждайте ddPCR.
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для Low VAF Signal 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 | LB-2026-001 | Идентификатор образца или лабораторной пробы. |
| 2 | VariantID | string / controlled vocabulary | EGFR:c.2573T>G | Контролируемый входной параметр для детерминированных QC-правил. |
| 3 | Gene | string / controlled vocabulary | EGFR | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | VariantType | string / controlled vocabulary | SNV | Контролируемый входной параметр для детерминированных QC-правил. |
| 5 | ObservedVAF_Percent | decimal | 0.35 | Контролируемый входной параметр для детерминированных QC-правил. |
| 6 | TotalDepth | decimal | 18500 | Контролируемый входной параметр для детерминированных QC-правил. |
| 7 | AltReads | decimal | 65 | Контролируемый входной параметр для детерминированных QC-правил. |
| 8 | ForwardAltReads | decimal | 30 | Контролируемый входной параметр для детерминированных QC-правил. |
| 9 | ReverseAltReads | decimal | 35 | Контролируемый входной параметр для детерминированных QC-правил. |
| 10 | UniqueMolecularFamilies | decimal | 12 | Контролируемый входной параметр для детерминированных QC-правил. |
| 11 | MinUMIFamilies | decimal | 3 | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | MeanFamilySize | decimal | 5.4 | Контролируемый входной параметр для детерминированных QC-правил. |
| 13 | MinMeanFamilySize | decimal | 3.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 14 | MappingQuality | decimal | 60 | Контролируемый входной параметр для детерминированных QC-правил. |
| 15 | MinMappingQuality | decimal | 40 | Контролируемый входной параметр для детерминированных QC-правил. |
| 16 | BaseQuality | decimal | 34 | Контролируемый входной параметр для детерминированных QC-правил. |
| 17 | MinBaseQuality | decimal | 25 | Контролируемый входной параметр для детерминированных QC-правил. |
| 18 | StrandBalanceRatio | decimal | 0.86 | Отношение компонентов; структурный или рецептурный CQA. |
| 19 | MinStrandBalance | decimal | 0.3 | Контролируемый входной параметр для детерминированных QC-правил. |
| 20 | BinomialPValue | decimal | 2.1E-15 | Контролируемый входной параметр для детерминированных QC-правил. |
| 21 | MaxBinomialPValue | decimal | 0.01 | Контролируемый входной параметр для детерминированных QC-правил. |
| 22 | FoundInPanelOfNormals | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 23 | FoundInNTC | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 24 | BackgroundNoiseAtPosition_VAF | decimal | 0.0001 | Контролируемый входной параметр для детерминированных QC-правил. |
| 25 | MaxBackgroundNoise_VAF | decimal | 0.001 | Контролируемый входной параметр для детерминированных QC-правил. |
| 26 | IsKnownHotspot | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 27 | IsInHomopolymerRegion | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 28 | IsInRepeatRegion | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 29 | GnomAD_AF | decimal | 0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 30 | AssayLOD_Percent | decimal | 0.1 | Контролируемый входной параметр для детерминированных QC-правил. |
SampleID,VariantID,Gene,VariantType,ObservedVAF_Percent,TotalDepth,AltReads,ForwardAltReads,ReverseAltReads,UniqueMolecularFamilies,MinUMIFamilies,MeanFamilySize,MinMeanFamilySize,MappingQuality,MinMappingQuality,BaseQuality,MinBaseQuality,StrandBalanceRatio,MinStrandBalance,BinomialPValue,MaxBinomialPValue,FoundInPanelOfNormals,FoundInNTC,BackgroundNoiseAtPosition_VAF,MaxBackgroundNoise_VAF,IsKnownHotspot,IsInHomopolymerRegion,IsInRepeatRegion,GnomAD_AF,AssayLOD_Percent
LB-2026-001,EGFR:c.2573T>G,EGFR,SNV,0.35,18500,65,30,35,12,3,5.4,3.0,60,40,34,25,0.86,0.3,2.1E-15,0.01,false,false,0.0001,0.001,true,false,false,0,0.1
LB-2026-001,TP53:c.743G>A,TP53,SNV,0.22,15000,33,31,2,2,3,16.5,3.0,35,40,28,25,0.06,0.3,0.003,0.01,true,false,0.0018,0.001,false,false,false,0.0002,0.1
LB-2026-002,KRAS:c.35G>A,KRAS,SNV,0.18,22000,40,18,22,4,3,10.0,3.0,58,40,32,25,0.82,0.3,8.5E-10,0.01,false,false,0.0008,0.001,true,false,false,0,0.1
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | SampleID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | VariantID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | Gene | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | VariantType | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | ObservedVAF_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | TotalDepth | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | AltReads | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | ForwardAltReads | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | ReverseAltReads | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | UniqueMolecularFamilies | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | MinUMIFamilies | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | MeanFamilySize | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | MinMeanFamilySize | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | MappingQuality | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | MinMappingQuality | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | BaseQuality | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | MinBaseQuality | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | StrandBalanceRatio | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | MinStrandBalance | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-020 | BinomialPValue | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-021 | MaxBinomialPValue | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-022 | FoundInPanelOfNormals | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-023 | FoundInNTC | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-024 | BackgroundNoiseAtPosition_VAF | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-025 | MaxBackgroundNoise_VAF | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-026 | IsKnownHotspot | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-027 | IsInHomopolymerRegion | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-028 | IsInRepeatRegion | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-029 | GnomAD_AF | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-030 | AssayLOD_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | 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 | Применить правила для Low VAF Signal 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": "lowvafsignalgatechecker",
"utilityFolder": "LowVafSignalGateChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "SampleID",
"value": "LB-2026-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "VariantID",
"value": "EGFR:c.2573T>G",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "Gene",
"value": "EGFR",
"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": "ObservedVAF_Percent",
"value": "0.35",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "TotalDepth",
"value": "18500",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "AltReads",
"value": "65",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "ForwardAltReads",
"value": "30",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "ReverseAltReads",
"value": "35",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "UniqueMolecularFamilies",
"value": "12",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "MinUMIFamilies",
"value": "3",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "MeanFamilySize",
"value": "5.4",
"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": "LowVafSignalGateChecker.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 и утверждёнными процедурами.