URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты PanelCoverageQcChecker для сценария Panel Coverage QC Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- • Percent Bases Above Min Depth ≥ 95%: Доля целевых баз с достаточной глубиной.
- • Minimum Depth: Абсолютный минимум не должен быть катастрофически низким (<50% от требуемого).
- • Uniformity ≥ 80%: Доля баз с глубиной ≥ 0.2× средней.
- • Fold-80 Base Penalty ≤ 2.0×: Во сколько раз нужно увеличить секвенирование для достижения 80% баз на целевой глубине.
- • Blind Spot Fraction ≤ 2%: Доля регионов ниже порога покрытия.
- КЛИНИЧЕСКИ КРИТИЧЕСКИЕ ПАРАМЕТРЫ:
- • Critical Regions Below Min Depth = 0: НИ ОДНОЙ слепой зоны в клинически значимых регионах.
- • GC Correlation |r| ≤ 0.3: Корреляция между GC-content и глубиной покрытия.
- • Off-Target Rate ≤ 20%: Специфичность обогащения.
- ⚠️ ВАЖНО:
- • Одна слепая зона в критическом гене (EGFR exon 19, BRCA1 exon 10) = INSUFFICIENT.
- • GC-bias >0.3 указывает на систематическую проблему обогащения или дизайна панели.
- • Fold-80 >2.0 означает, что >20% базы требуют непропорционального пересеквенирования.
- • Off-target >20% снижает эффективную глубину и увеличивает стоимость.
- 1. Per-Region BED: Используйте BED-файл с аннотацией критических регионов для автоматической проверки.
- 2. GC Stratification: Анализируйте покрытие стратифицированно по GC-content (bins: <30%, 30-40%, ..., >70%).
- ⚠️ Примечание: Утилита оценивает ТЕХНИЧЕСКОЕ ПОКРЫТИЕ панели. Она не заменяет проверку аналитической чувствительности (LoD) для конкретных вариантов в каждом регионе. Покрытие ≥100× необходимо, но не достаточно для гарантии LoD; требуется эмпирическая верификация.
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для Panel Coverage QC 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 | RunID | string / controlled vocabulary | COV-2026-001 | Контролируемый входной параметр для детерминированных QC-правил. |
| 2 | PanelName | string / controlled vocabulary | OncoPanel_500 | Контролируемый входной параметр для детерминированных QC-правил. |
| 3 | PanelVersion | string / controlled vocabulary | v4.2 | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | Platform | string / controlled vocabulary | NovaSeq | Контролируемый входной параметр для детерминированных QC-правил. |
| 5 | MeanTargetDepth_X | string / controlled vocabulary | 850 | Контролируемый входной параметр для детерминированных QC-правил. |
| 6 | MedianTargetDepth_X | string / controlled vocabulary | 820 | Контролируемый входной параметр для детерминированных QC-правил. |
| 7 | MinTargetDepth_X | string / controlled vocabulary | 120 | Контролируемый входной параметр для детерминированных QC-правил. |
| 8 | RequiredMinDepth_X | decimal | 100 | Контролируемый входной параметр для детерминированных QC-правил. |
| 9 | PercentBases_Above_MinDepth | decimal | 98.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 10 | MinPercentBases_Above_MinDepth | decimal | 95 | Контролируемый входной параметр для детерминированных QC-правил. |
| 11 | Uniformity_Percent | decimal | 93.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | MinUniformity_Percent | decimal | 80 | Контролируемый входной параметр для детерминированных QC-правил. |
| 13 | Fold80_BasePenalty | decimal | 1.3 | Контролируемый входной параметр для детерминированных QC-правил. |
| 14 | MaxFold80 | decimal | 2.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 15 | TotalTargetRegions | string / controlled vocabulary | 5200 | Контролируемый входной параметр для детерминированных QC-правил. |
| 16 | RegionsBelowMinDepth | decimal | 78 | Контролируемый входной параметр для детерминированных QC-правил. |
| 17 | CriticalRegionsBelowMinDepth | decimal | 0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 18 | TotalCriticalRegions | decimal | 450 | Контролируемый входной параметр для детерминированных QC-правил. |
| 19 | MaxAllowedBlindSpot_Fraction | integer / decimal | 0.02 | Контролируемый входной параметр для детерминированных QC-правил. |
| 20 | GCCorrelation_Coefficient | decimal | 0.12 | Контролируемый входной параметр для детерминированных QC-правил. |
| 21 | MaxGCCorrelation | integer / decimal | 0.3 | Контролируемый входной параметр для детерминированных QC-правил. |
| 22 | HighGC_Regions_BelowThreshold_Count | integer / decimal | 15 | Счётный показатель; используется для микробиологического, частичного или клеточного контроля. |
| 23 | LowGC_Regions_BelowThreshold_Count | integer / decimal | 8 | Счётный показатель; используется для микробиологического, частичного или клеточного контроля. |
| 24 | KnownProblematicRegions_Total | decimal | 25 | Контролируемый входной параметр для детерминированных QC-правил. |
| 25 | KnownProblematicRegions_Covered | decimal | 25 | Контролируемый входной параметр для детерминированных QC-правил. |
| 26 | UncoveredProblematicRegions | string / controlled vocabulary | | Контролируемый входной параметр для детерминированных QC-правил. |
| 27 | ClinicalGenes_Total | decimal | 50 | Контролируемый входной параметр для детерминированных QC-правил. |
| 28 | ClinicalGenes_FullyCovered | decimal | 50 | Контролируемый входной параметр для детерминированных QC-правил. |
| 29 | PartiallyCoveredGenes | string / controlled vocabulary | | Контролируемый входной параметр для детерминированных QC-правил. |
| 30 | OffTargetRate_Percent | decimal | 8.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 31 | MaxOffTargetRate_Percent | decimal | 20 | Контролируемый входной параметр для детерминированных QC-правил. |
| 32 | RepeatMasking_Applied | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 33 | SegmentalDuplication_Flagged | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
RunID,PanelName,PanelVersion,Platform,MeanTargetDepth_X,MedianTargetDepth_X,MinTargetDepth_X,RequiredMinDepth_X,PercentBases_Above_MinDepth,MinPercentBases_Above_MinDepth,Uniformity_Percent,MinUniformity_Percent,Fold80_BasePenalty,MaxFold80,TotalTargetRegions,RegionsBelowMinDepth,CriticalRegionsBelowMinDepth,TotalCriticalRegions,MaxAllowedBlindSpot_Fraction,GCCorrelation_Coefficient,MaxGCCorrelation,HighGC_Regions_BelowThreshold_Count,LowGC_Regions_BelowThreshold_Count,KnownProblematicRegions_Total,KnownProblematicRegions_Covered,UncoveredProblematicRegions,ClinicalGenes_Total,ClinicalGenes_FullyCovered,PartiallyCoveredGenes,OffTargetRate_Percent,MaxOffTargetRate_Percent,RepeatMasking_Applied,SegmentalDuplication_Flagged
COV-2026-001,OncoPanel_500,v4.2,NovaSeq,850,820,120,100,98.5,95,93.0,80,1.3,2.0,5200,78,0,450,0.02,0.12,0.3,15,8,25,25,,50,50,,8.5,20,true,true
COV-2026-002,HemePanel_300,v2.1,NextSeq,450,380,15,100,82.0,95,68.0,80,3.5,2.0,3100,558,12,280,0.02,0.55,0.3,185,92,18,10,FLT3_ITD;CEBPA_TAD;NPM1_exon12,40,35,FLT3;CEBPA;DNMT3A;TET2;ASXL1,22.0,20,false,false
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | RunID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | PanelName | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | PanelVersion | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | Platform | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | MeanTargetDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | MedianTargetDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | MinTargetDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | RequiredMinDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | PercentBases_Above_MinDepth | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | MinPercentBases_Above_MinDepth | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | Uniformity_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | MinUniformity_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | Fold80_BasePenalty | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | MaxFold80 | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | TotalTargetRegions | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | RegionsBelowMinDepth | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | CriticalRegionsBelowMinDepth | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | TotalCriticalRegions | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | MaxAllowedBlindSpot_Fraction | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-020 | GCCorrelation_Coefficient | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-021 | MaxGCCorrelation | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-022 | HighGC_Regions_BelowThreshold_Count | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-023 | LowGC_Regions_BelowThreshold_Count | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-024 | KnownProblematicRegions_Total | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-025 | KnownProblematicRegions_Covered | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-026 | UncoveredProblematicRegions | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-027 | ClinicalGenes_Total | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-028 | ClinicalGenes_FullyCovered | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-029 | PartiallyCoveredGenes | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-030 | OffTargetRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-031 | MaxOffTargetRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-032 | RepeatMasking_Applied | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-033 | SegmentalDuplication_Flagged | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | 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 | Применить правила для Panel Coverage QC 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": "panelcoverageqcchecker",
"utilityFolder": "PanelCoverageQcChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "RunID",
"value": "COV-2026-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "PanelName",
"value": "OncoPanel_500",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "PanelVersion",
"value": "v4.2",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "Platform",
"value": "NovaSeq",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "MeanTargetDepth_X",
"value": "850",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "MedianTargetDepth_X",
"value": "820",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "MinTargetDepth_X",
"value": "120",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "RequiredMinDepth_X",
"value": "100",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "PercentBases_Above_MinDepth",
"value": "98.5",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "MinPercentBases_Above_MinDepth",
"value": "95",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "Uniformity_Percent",
"value": "93.0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "MinUniformity_Percent",
"value": "80",
"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": "PanelCoverageQcChecker.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 и утверждёнными процедурами.