URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты NgsRunQcChecker для сценария NGS Run QC Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- • Total Reads ≥ Minimum: Достаточный выход данных для целевой глубины.
- • Q30 ≥ Threshold: Качество баз (порог зависит от платформы и типа панели).
- • Pass-Filter Rate ≥ 70%: Доля прочтений, прошедших фильтр качества Illumina.
- • On-Target Rate ≥ 60%: Эффективность захвата целевых регионов.
- • Uniformity ≥ 80%: Равномерность покрытия (% баз ≥ 0.2× средней глубины).
- • Mean Target Depth ≥ Minimum: Средняя глубина покрытия целевых регионов.
- • Fold-80 Base Penalty ≤ 2.0: Мера неравномерности (сколько нужно досеквенировать для 80% баз).
- • Alignment Rate ≥ 90%: Доля прочтений, успешно выровненных на референс.
- • Duplication Rate ≤ 30%: Уровень PCR/optical дупликатов (зависит от типа библиотеки).
- • Contamination Estimate ≤ 2%: Оценка межобразцовой контаминации.
- • Index Hopping Rate ≤ 0.5%: Перекрестное загрязнение через индексы.
- • PhiX Control: Подтверждение качества химии секвенирования (error rate ≤ 2%).
- • Sample Pass Rate ≥ 80%: Доля образцов в запуске, прошедших индивидуальные QC.
- ⚠️ ВАЖНО:
- • Contamination >2% делает соматические вызовы ненадежными.
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для NGS Run 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 | NGS-RUN-2026-001 | Контролируемый входной параметр для детерминированных QC-правил. |
| 2 | PanelType | string / controlled vocabulary | Targeted_Panel | Контролируемый входной параметр для детерминированных QC-правил. |
| 3 | Platform | string / controlled vocabulary | NovaSeq 6000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | ReadLength | string / controlled vocabulary | 2x150 | Контролируемый входной параметр для детерминированных QC-правил. |
| 5 | TotalReads_Million | integer / decimal | 250 | Контролируемый входной параметр для детерминированных QC-правил. |
| 6 | MinTotalReads_Million | integer / decimal | 100 | Контролируемый входной параметр для детерминированных QC-правил. |
| 7 | PercentQ30 | decimal | 89.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 8 | MinQ30 | decimal | 75 | Контролируемый входной параметр для детерминированных QC-правил. |
| 9 | ClusterDensity_K_mm2 | decimal | 950 | Контролируемый входной параметр для детерминированных QC-правил. |
| 10 | MinClusterDensity | decimal | 800 | Контролируемый входной параметр для детерминированных QC-правил. |
| 11 | MaxClusterDensity | decimal | 1200 | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | PercentPF | decimal | 88.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 13 | MinPercentPF | decimal | 70 | Контролируемый входной параметр для детерминированных QC-правил. |
| 14 | OnTargetRate_Percent | decimal | 82.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 15 | MinOnTargetRate_Percent | decimal | 60 | Контролируемый входной параметр для детерминированных QC-правил. |
| 16 | Uniformity_Percent | decimal | 93.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 17 | MinUniformity_Percent | decimal | 80 | Контролируемый входной параметр для детерминированных QC-правил. |
| 18 | MeanTargetDepth_X | string / controlled vocabulary | 850 | Контролируемый входной параметр для детерминированных QC-правил. |
| 19 | MinMeanTargetDepth_X | string / controlled vocabulary | 500 | Контролируемый входной параметр для детерминированных QC-правил. |
| 20 | Fold80_BasePenalty | decimal | 1.3 | Контролируемый входной параметр для детерминированных QC-правил. |
| 21 | MaxFold80 | decimal | 2.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 22 | AlignmentRate_Percent | decimal | 98.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 23 | MinAlignmentRate_Percent | decimal | 90 | Контролируемый входной параметр для детерминированных QC-правил. |
| 24 | DuplicationRate_Percent | decimal | 12.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 25 | MaxDuplicationRate_Percent | decimal | 30 | Контролируемый входной параметр для детерминированных QC-правил. |
| 26 | InsertSize_Mean_bp | decimal | 285 | Контролируемый входной параметр для детерминированных QC-правил. |
| 27 | InsertSize_SD_bp | decimal | 45 | Контролируемый входной параметр для детерминированных QC-правил. |
| 28 | ContaminationEstimate_Percent | decimal | 0.3 | Контролируемый входной параметр для детерминированных QC-правил. |
| 29 | MaxContamination_Percent | decimal | 2.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 30 | PositiveControl_Pass | string / controlled vocabulary | true | Контрольная точка/контрольный образец для валидности серии анализа. |
| 31 | NegativeControl_Pass | string / controlled vocabulary | true | Контрольная точка/контрольный образец для валидности серии анализа. |
| 32 | PhiX_Control_Pass | string / controlled vocabulary | true | pH; параметр стабильности, совместимости и пригодности серии. |
| 33 | PhiX_ErrorRate | decimal | 0.15 | pH; параметр стабильности, совместимости и пригодности серии. |
| 34 | MaxPhiX_ErrorRate | decimal | 2.0 | pH; параметр стабильности, совместимости и пригодности серии. |
| 35 | SamplesInRun | string / controlled vocabulary | 24 | Идентификатор образца или лабораторной пробы. |
| 36 | SamplesPassingQC | decimal | 24 | Идентификатор образца или лабораторной пробы. |
| 37 | IndexHoppingRate_Percent | decimal | 0.04 | Контролируемый входной параметр для детерминированных QC-правил. |
| 38 | MaxIndexHoppingRate_Percent | decimal | 0.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 39 | UDI_Used | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
RunID,PanelType,Platform,ReadLength,TotalReads_Million,MinTotalReads_Million,PercentQ30,MinQ30,ClusterDensity_K_mm2,MinClusterDensity,MaxClusterDensity,PercentPF,MinPercentPF,OnTargetRate_Percent,MinOnTargetRate_Percent,Uniformity_Percent,MinUniformity_Percent,MeanTargetDepth_X,MinMeanTargetDepth_X,Fold80_BasePenalty,MaxFold80,AlignmentRate_Percent,MinAlignmentRate_Percent,DuplicationRate_Percent,MaxDuplicationRate_Percent,InsertSize_Mean_bp,InsertSize_SD_bp,ContaminationEstimate_Percent,MaxContamination_Percent,PositiveControl_Pass,NegativeControl_Pass,PhiX_Control_Pass,PhiX_ErrorRate,MaxPhiX_ErrorRate,SamplesInRun,SamplesPassingQC,IndexHoppingRate_Percent,MaxIndexHoppingRate_Percent,UDI_Used
NGS-RUN-2026-001,Targeted_Panel,NovaSeq 6000,2x150,250,100,89.5,75,950,800,1200,88.0,70,82.0,60,93.0,80,850,500,1.3,2.0,98.5,90,12.0,30,285,45,0.3,2.0,true,true,true,0.15,2.0,24,24,0.04,0.5,true
NGS-RUN-2026-002,WES,NextSeq 2000,2x150,180,100,72.0,75,1350,800,1200,62.0,70,48.0,60,65.0,80,45,100,3.8,2.0,85.0,90,45.0,30,320,85,4.5,2.0,true,false,true,0.8,2.0,16,8,1.2,0.5,false
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | RunID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | PanelType | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | Platform | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | ReadLength | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | TotalReads_Million | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | MinTotalReads_Million | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | PercentQ30 | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | MinQ30 | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | ClusterDensity_K_mm2 | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | MinClusterDensity | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | MaxClusterDensity | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | PercentPF | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | MinPercentPF | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | OnTargetRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | MinOnTargetRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | Uniformity_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | MinUniformity_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | MeanTargetDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | MinMeanTargetDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-020 | Fold80_BasePenalty | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-021 | MaxFold80 | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-022 | AlignmentRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-023 | MinAlignmentRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-024 | DuplicationRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-025 | MaxDuplicationRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-026 | InsertSize_Mean_bp | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-027 | InsertSize_SD_bp | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-028 | ContaminationEstimate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-029 | MaxContamination_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-030 | PositiveControl_Pass | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-031 | NegativeControl_Pass | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-032 | PhiX_Control_Pass | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-033 | PhiX_ErrorRate | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-034 | MaxPhiX_ErrorRate | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-035 | SamplesInRun | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-036 | SamplesPassingQC | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-037 | IndexHoppingRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-038 | MaxIndexHoppingRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-039 | UDI_Used | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | 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 | Применить правила для NGS Run 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": "ngsrunqcchecker",
"utilityFolder": "NgsRunQcChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "RunID",
"value": "NGS-RUN-2026-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "PanelType",
"value": "Targeted_Panel",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "Platform",
"value": "NovaSeq 6000",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "ReadLength",
"value": "2x150",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "TotalReads_Million",
"value": "250",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "MinTotalReads_Million",
"value": "100",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "PercentQ30",
"value": "89.5",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "MinQ30",
"value": "75",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "ClusterDensity_K_mm2",
"value": "950",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "MinClusterDensity",
"value": "800",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "MaxClusterDensity",
"value": "1200",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "PercentPF",
"value": "88.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": "NgsRunQcChecker.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 и утверждёнными процедурами.