URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты LiquidCgpRunQcChecker для сценария Liquid CGP Run QC Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- • On-Target Rate: Эффективность захвата целевых регионов (≥60%).
- • Uniformity: Равномерность покрытия (≥80%) — предотвращение слепых зон.
- • Mean Target Depth: Общая глубина (≥10 000× для cfDNA CGP).
- • Fold-80 Base Penalty: Мера неравномерности (≤2.0).
- • UMI Deduplication Rate: Доля коллапсированных прочтений (≤85%).
- • Unique Molecular Depth: Глубина после дедупликации (≥1 000×) — определяет реальную чувствительность.
- • Duplication Rate: Общий уровень дупликатов (≤40%).
- • Background Noise VAF: Медианный шум в NTC (≤0.1% VAF).
- • Positive Control Recovery: Восстановление контрольного варианта (≥70%).
- • Index Hopping Rate: Перекрестная контаминация (≤0.5%).
- ⚠️ ВАЖНО:
- • Фон >0.1% VAF делает невозможным надежное обнаружение при VAF <0.5%.
- Жидкая биопсия работает на пределе чувствительности (VAF 0.1–0.5%).
- ⚠️ КРИТИЧЕСКИ ВАЖНО:
- • Mean Target Depth ≥ 10 000×: Базовый порог для cfDNA CGP.
- • Unique Molecular Depth ≥ 1 000×: Определяет реальную чувствительность.
- • Uniformity ≥ 80%: Ниже = неприемлемые слепые зоны.
- • Background Noise ≤ 0.1% VAF: Превышение = LOD недостижим.
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для Liquid CGP 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 | LB-RUN-2026-001 | Контролируемый входной параметр для детерминированных QC-правил. |
| 2 | PanelName | string / controlled vocabulary | OncoLiquid_500 | Контролируемый входной параметр для детерминированных QC-правил. |
| 3 | Platform | string / controlled vocabulary | NovaSeq 6000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | PercentQ30 | decimal | 89.2 | Контролируемый входной параметр для детерминированных QC-правил. |
| 5 | MinQ30 | decimal | 75 | Контролируемый входной параметр для детерминированных QC-правил. |
| 6 | ClusterDensity_K_mm2 | decimal | 920 | Контролируемый входной параметр для детерминированных QC-правил. |
| 7 | MinClusterDensity | decimal | 800 | Контролируемый входной параметр для детерминированных QC-правил. |
| 8 | MaxClusterDensity | decimal | 1200 | Контролируемый входной параметр для детерминированных QC-правил. |
| 9 | OnTargetRate_Percent | decimal | 82.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 10 | MinOnTargetRate | string / controlled vocabulary | 60 | Контролируемый входной параметр для детерминированных QC-правил. |
| 11 | Uniformity_Percent | decimal | 93.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | MinUniformity | decimal | 80 | Контролируемый входной параметр для детерминированных QC-правил. |
| 13 | MeanTargetDepth_X | string / controlled vocabulary | 22000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 14 | MinMeanTargetDepth | string / controlled vocabulary | 10000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 15 | Fold80_BasePenalty | decimal | 1.2 | Контролируемый входной параметр для детерминированных QC-правил. |
| 16 | MaxFold80 | decimal | 2.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 17 | UMIDeduplication_Rate | string / controlled vocabulary | 0.68 | Контролируемый входной параметр для детерминированных QC-правил. |
| 18 | MaxUMIDeduplication | string / controlled vocabulary | 0.85 | Контролируемый входной параметр для детерминированных QC-правил. |
| 19 | UniqueMolecularDepth_X | decimal | 7200 | Контролируемый входной параметр для детерминированных QC-правил. |
| 20 | MinUniqueMolecularDepth | decimal | 1000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 21 | DuplicationRate_Percent | decimal | 18.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 22 | MaxDuplicationRate | decimal | 40 | Контролируемый входной параметр для детерминированных QC-правил. |
| 23 | BackgroundNoise_VAF | decimal | 0.0002 | Контролируемый входной параметр для детерминированных QC-правил. |
| 24 | MaxBackgroundNoise_VAF | decimal | 0.001 | Контролируемый входной параметр для детерминированных QC-правил. |
| 25 | NTCSamples_Total | string / controlled vocabulary | 4 | Идентификатор образца или лабораторной пробы. |
| 26 | NTCSamples_Pass | string / controlled vocabulary | 4 | Идентификатор образца или лабораторной пробы. |
| 27 | PositiveControl_Detected | string / controlled vocabulary | true | Контрольная точка/контрольный образец для валидности серии анализа. |
| 28 | PositiveControl_Recovery_Percent | decimal | 95.0 | Восстановление/извлечение; показатель валидности анализа. |
| 29 | MinPositiveControl_Recovery | decimal | 70 | Восстановление/извлечение; показатель валидности анализа. |
| 30 | IndexHoppingRate_Percent | decimal | 0.05 | Контролируемый входной параметр для детерминированных QC-правил. |
| 31 | MaxIndexHoppingRate | decimal | 0.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 32 | UDI_Used | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
RunID,PanelName,Platform,PercentQ30,MinQ30,ClusterDensity_K_mm2,MinClusterDensity,MaxClusterDensity,OnTargetRate_Percent,MinOnTargetRate,Uniformity_Percent,MinUniformity,MeanTargetDepth_X,MinMeanTargetDepth,Fold80_BasePenalty,MaxFold80,UMIDeduplication_Rate,MaxUMIDeduplication,UniqueMolecularDepth_X,MinUniqueMolecularDepth,DuplicationRate_Percent,MaxDuplicationRate,BackgroundNoise_VAF,MaxBackgroundNoise_VAF,NTCSamples_Total,NTCSamples_Pass,PositiveControl_Detected,PositiveControl_Recovery_Percent,MinPositiveControl_Recovery,IndexHoppingRate_Percent,MaxIndexHoppingRate,UDI_Used
LB-RUN-2026-001,OncoLiquid_500,NovaSeq 6000,89.2,75,920,800,1200,82.5,60,93.0,80,22000,10000,1.2,2.0,0.68,0.85,7200,1000,18.0,40,0.0002,0.001,4,4,true,95.0,70,0.05,0.5,true
LB-RUN-2026-002,OncoLiquid_500,NovaSeq 6000,71.0,75,1400,800,1200,48.0,60,65.0,80,6500,10000,3.5,2.0,0.92,0.85,520,1000,62.0,40,0.003,0.001,4,2,true,55.0,70,1.8,0.5,false
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | RunID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | PanelName | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | Platform | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | PercentQ30 | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | MinQ30 | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | ClusterDensity_K_mm2 | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | MinClusterDensity | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | MaxClusterDensity | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | OnTargetRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | MinOnTargetRate | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | Uniformity_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | MinUniformity | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | MeanTargetDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | MinMeanTargetDepth | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | Fold80_BasePenalty | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | MaxFold80 | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | UMIDeduplication_Rate | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | MaxUMIDeduplication | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | UniqueMolecularDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-020 | MinUniqueMolecularDepth | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-021 | DuplicationRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-022 | MaxDuplicationRate | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-023 | BackgroundNoise_VAF | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-024 | MaxBackgroundNoise_VAF | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-025 | NTCSamples_Total | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-026 | NTCSamples_Pass | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-027 | PositiveControl_Detected | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-028 | PositiveControl_Recovery_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-029 | MinPositiveControl_Recovery | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-030 | IndexHoppingRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-031 | MaxIndexHoppingRate | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-032 | 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 | Применить правила для Liquid CGP 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": "liquidcgprunqcchecker",
"utilityFolder": "LiquidCgpRunQcChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "RunID",
"value": "LB-RUN-2026-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "PanelName",
"value": "OncoLiquid_500",
"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": "PercentQ30",
"value": "89.2",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "MinQ30",
"value": "75",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "ClusterDensity_K_mm2",
"value": "920",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "MinClusterDensity",
"value": "800",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "MaxClusterDensity",
"value": "1200",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "OnTargetRate_Percent",
"value": "82.5",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "MinOnTargetRate",
"value": "60",
"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",
"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": "LiquidCgpRunQcChecker.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 и утверждёнными процедурами.