URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты SequencingDepthGateChecker для сценария Sequencing Depth Gate Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- • Mean Target Depth ≥ Required: Средняя глубина по целевым регионам.
- • Percent Bases Above Min Depth ≥ 95%: Доля баз с достаточным покрытием.
- • Min Depth: Абсолютный минимум; должен быть >0 для всех критических регионов.
- • Fold-80 Base Penalty ≤ 2.0×: Во сколько раз нужно увеличить секвенирование для покрытия 80% баз на целевой глубине.
- • Uniformity ≥ 80%: Доля баз с глубиной ≥ 0.2× средней.
- • Depth Floor (% at 10% mean): Доля баз с глубиной ≥ 10% от средней. Индикатор «хвоста» распределения.
- КРИТИЧЕСКИЕ РЕГИОНЫ И ГОРЯЧИЕ ТОЧКИ:
- • Critical Regions at Min Depth = 100%: ВСЕ клинически значимые регионы должны быть покрыты.
- • Critical Hotspots at Min Depth = 100%: ВСЕ терапевтически значимые варианты должны быть детектируемы.
- • ⛔ Любой непокрытый критический регион = потенциальный ложноотрицательный результат.
- • Unique Molecular Depth ≥ Required: Глубина после дедупликации (для UMI-ассеев).
- • Mean Family Size ≥ 3.0: Минимальный размер консенсусного семейства.
- • ⚠ Для cfDNA/somatic: именно UMI depth определяет реальную чувствительность, не raw depth.
- • On-Target Rate ≥ 60%: Эффективность обогащения.
- • GC Bias Correlation ≤ 0.3: Отсутствие систематического недопокрытия GC-rich/poor регионов.
- • Duplicate Rate ≤ 30%: Высокая дупликация снижает эффективную глубину.
- ⚠️ ВАЖНО:
- • Для UMI-ассеев raw depth может быть 20 000×, но unique molecular depth только 500× — именно последнее определяет LOD.
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для Sequencing Depth 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 | DEP-2026-001 | Идентификатор образца или лабораторной пробы. |
| 2 | PatientID | string / controlled vocabulary | PAT-LUNG-042 | Контролируемый входной параметр для детерминированных QC-правил. |
| 3 | AssayName | string / controlled vocabulary | OncoPanel_500 | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | AssayType | string / controlled vocabulary | Somatic_Targeted | Контролируемый входной параметр для детерминированных QC-правил. |
| 5 | PanelName | string / controlled vocabulary | NSCLC_CGP | Контролируемый входной параметр для детерминированных QC-правил. |
| 6 | MeanTargetDepth_X | string / controlled vocabulary | 850 | Контролируемый входной параметр для детерминированных QC-правил. |
| 7 | MedianTargetDepth_X | string / controlled vocabulary | 820 | Контролируемый входной параметр для детерминированных QC-правил. |
| 8 | MinTargetDepth_X | string / controlled vocabulary | 180 | Контролируемый входной параметр для детерминированных QC-правил. |
| 9 | PercentBases_Above_MinDepth | decimal | 98.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 10 | RequiredMinDepth_X | decimal | 100 | Контролируемый входной параметр для детерминированных QC-правил. |
| 11 | RequiredMeanDepth_X | decimal | 500 | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | RequiredPercentAbove_MinDepth | decimal | 95 | Контролируемый входной параметр для детерминированных QC-правил. |
| 13 | Fold80_BasePenalty | decimal | 1.4 | Контролируемый входной параметр для детерминированных QC-правил. |
| 14 | MaxFold80_Allowed | decimal | 2.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 15 | Uniformity_Percent | decimal | 92.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 16 | MinUniformity_Percent | decimal | 80 | Контролируемый входной параметр для детерминированных QC-правил. |
| 17 | PercentBases_At10pctMean | integer / decimal | 97.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 18 | MinPercentBases_At10pctMean | integer / decimal | 90 | Контролируемый входной параметр для детерминированных QC-правил. |
| 19 | UMI_Assay | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 20 | UniqueMolecularDepth_X | decimal | 3200 | Контролируемый входной параметр для детерминированных QC-правил. |
| 21 | RequiredUniqueMolecularDepth_X | decimal | 1000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 22 | UMIDeduplication_Rate | string / controlled vocabulary | 0.45 | Контролируемый входной параметр для детерминированных QC-правил. |
| 23 | MeanFamilySize | decimal | 4.2 | Контролируемый входной параметр для детерминированных QC-правил. |
| 24 | MinMeanFamilySize | decimal | 3.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 25 | TotalCriticalRegions | decimal | 150 | Контролируемый входной параметр для детерминированных QC-правил. |
| 26 | CriticalRegions_AtMinDepth | decimal | 150 | Контролируемый входной параметр для детерминированных QC-правил. |
| 27 | CriticalHotspots_Total | decimal | 45 | Контролируемый входной параметр для детерминированных QC-правил. |
| 28 | CriticalHotspots_AtMinDepth | decimal | 45 | Контролируемый входной параметр для детерминированных QC-правил. |
| 29 | UncoveredCriticalRegions | string / controlled vocabulary | | Контролируемый входной параметр для детерминированных QC-правил. |
| 30 | UncoveredHotspots | string / controlled vocabulary | | Контролируемый входной параметр для детерминированных QC-правил. |
| 31 | OnTargetRate_Percent | decimal | 85.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 32 | MinOnTargetRate_Percent | decimal | 60 | Контролируемый входной параметр для детерминированных QC-правил. |
| 33 | TotalReads_Million | integer / decimal | 25 | Контролируемый входной параметр для детерминированных QC-правил. |
| 34 | OnTargetReads_Million | string / controlled vocabulary | 21 | Контролируемый входной параметр для детерминированных QC-правил. |
| 35 | TargetLOD_VAF_Percent | decimal | 0.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 36 | GCBias_Correlation | integer / decimal | 0.08 | Контролируемый входной параметр для детерминированных QC-правил. |
| 37 | MaxGCBias_Correlation | integer / decimal | 0.3 | Контролируемый входной параметр для детерминированных QC-правил. |
| 38 | DuplicateRate_High | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 39 | DuplicateRate_Percent | decimal | 12.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 40 | MaxDuplicateRate_Percent | decimal | 30 | Контролируемый входной параметр для детерминированных QC-правил. |
SampleID,PatientID,AssayName,AssayType,PanelName,MeanTargetDepth_X,MedianTargetDepth_X,MinTargetDepth_X,PercentBases_Above_MinDepth,RequiredMinDepth_X,RequiredMeanDepth_X,RequiredPercentAbove_MinDepth,Fold80_BasePenalty,MaxFold80_Allowed,Uniformity_Percent,MinUniformity_Percent,PercentBases_At10pctMean,MinPercentBases_At10pctMean,UMI_Assay,UniqueMolecularDepth_X,RequiredUniqueMolecularDepth_X,UMIDeduplication_Rate,MeanFamilySize,MinMeanFamilySize,TotalCriticalRegions,CriticalRegions_AtMinDepth,CriticalHotspots_Total,CriticalHotspots_AtMinDepth,UncoveredCriticalRegions,UncoveredHotspots,OnTargetRate_Percent,MinOnTargetRate_Percent,TotalReads_Million,OnTargetReads_Million,TargetLOD_VAF_Percent,GCBias_Correlation,MaxGCBias_Correlation,DuplicateRate_High,DuplicateRate_Percent,MaxDuplicateRate_Percent
DEP-2026-001,PAT-LUNG-042,OncoPanel_500,Somatic_Targeted,NSCLC_CGP,850,820,180,98.5,100,500,95,1.4,2.0,92.0,80,97.5,90,true,3200,1000,0.45,4.2,3.0,150,150,45,45,,,85.0,60,25,21,0.5,0.08,0.3,false,12.0,30
DEP-2026-002,PAT-CRC-055,CRC_Panel,Hybrid_Capture,CRC_200,320,180,15,72.0,100,500,95,3.8,2.0,62.0,80,75.0,90,false,0,0,0,0,0,80,68,25,22,APC_exon15;SMAD4_exon2;TGFBR2_exon3,KRAS_G13D;BRAF_V600E,55.0,60,12,7,1.0,0.45,0.3,true,42.0,30
DEP-2026-003,PAT-BRCA-061,MRD_Panel,cfDNA_Panel,Breast_MRD,18000,15000,2500,94.0,5000,20000,95,1.8,2.0,85.0,80,92.0,90,true,1800,2000,0.72,8.5,3.0,60,58,20,20,ESR1_Y537S_region,,78.0,60,80,62,0.01,0.12,0.3,false,25.0,30
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | SampleID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | PatientID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | AssayName | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | AssayType | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | PanelName | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | MeanTargetDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | MedianTargetDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | MinTargetDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | PercentBases_Above_MinDepth | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | RequiredMinDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | RequiredMeanDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | RequiredPercentAbove_MinDepth | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | Fold80_BasePenalty | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | MaxFold80_Allowed | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | Uniformity_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | MinUniformity_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | PercentBases_At10pctMean | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | MinPercentBases_At10pctMean | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | UMI_Assay | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-020 | UniqueMolecularDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-021 | RequiredUniqueMolecularDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-022 | UMIDeduplication_Rate | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-023 | MeanFamilySize | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-024 | MinMeanFamilySize | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-025 | TotalCriticalRegions | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-026 | CriticalRegions_AtMinDepth | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-027 | CriticalHotspots_Total | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-028 | CriticalHotspots_AtMinDepth | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-029 | UncoveredCriticalRegions | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-030 | UncoveredHotspots | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-031 | OnTargetRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-032 | MinOnTargetRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-033 | TotalReads_Million | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-034 | OnTargetReads_Million | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-035 | TargetLOD_VAF_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-036 | GCBias_Correlation | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-037 | MaxGCBias_Correlation | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-038 | DuplicateRate_High | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-039 | DuplicateRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-040 | MaxDuplicateRate_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 | Применить правила для Sequencing Depth 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": "sequencingdepthgatechecker",
"utilityFolder": "SequencingDepthGateChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "SampleID",
"value": "DEP-2026-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "PatientID",
"value": "PAT-LUNG-042",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "AssayName",
"value": "OncoPanel_500",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "AssayType",
"value": "Somatic_Targeted",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "PanelName",
"value": "NSCLC_CGP",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "MeanTargetDepth_X",
"value": "850",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "MedianTargetDepth_X",
"value": "820",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "MinTargetDepth_X",
"value": "180",
"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": "RequiredMinDepth_X",
"value": "100",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "RequiredMeanDepth_X",
"value": "500",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "RequiredPercentAbove_MinDepth",
"value": "95",
"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": "SequencingDepthGateChecker.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 и утверждёнными процедурами.