URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты IndexHoppingContaminationChecker для сценария Index Hopping Contamination Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- ⚠️ ВАЖНО:
- • Для жидкой биопсии (VAF <0.5%) даже 0.1% контаминации может вызвать ложноположительный результат.
- • Жидкая биопсия: Критический контроль для ultrasensitive assays (VAF <0.5%).
- ⚠️ КРИТИЧЕСКИ ВАЖНО:
- • Contamination vs Sensitivity: Если Estimated Contamination ≥ Required VAF → данные НЕПРИГОДНЫ.
- • Четырёхуровневая классификация (Clean / Low / High / Critical)
- Критические параметры:
- • Hopping Rate: ≤ 0.5% (typical threshold)
- • Estimated Contamination: ≤ Assay-specific limit
- • Contamination vs VAF Threshold: Contamination < Required Sensitivity
- 2. Балансируйте пул: Избегайте >10× разницы в молярности между образцами.
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для Index Hopping Contamination 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 | RUN-2026-045 | Контролируемый входной параметр для детерминированных QC-правил. |
| 2 | SampleID | string / controlled vocabulary | LB-PAT-001 | Идентификатор образца или лабораторной пробы. |
| 3 | ExpectedIndex_I7 | string / controlled vocabulary | ATTACTCG | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | ExpectedIndex_I5 | string / controlled vocabulary | TATAGCCT | Контролируемый входной параметр для детерминированных QC-правил. |
| 5 | AssignedReads | decimal | 25000000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 6 | HoppedReads_Total | decimal | 12500 | Контролируемый входной параметр для детерминированных QC-правил. |
| 7 | HoppedReads_FromHighAbundance | decimal | 8500 | Контролируемый входной параметр для детерминированных QC-правил. |
| 8 | HoppingRate_Percent | decimal | 0.05 | Контролируемый входной параметр для детерминированных QC-правил. |
| 9 | MaxAcceptableHoppingRate_Percent | decimal | 0.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 10 | EstimatedContamination_Percent | decimal | 0.02 | Контролируемый входной параметр для детерминированных QC-правил. |
| 11 | MaxAcceptableContamination_Percent | decimal | 0.1 | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | TopDonorSample | string / controlled vocabulary | LB-PAT-003 | Идентификатор образца или лабораторной пробы. |
| 13 | DonorContribution_Percent | decimal | 68.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 14 | DualIndexUsed | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 15 | UniqueDualIndex | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 16 | Platform | string / controlled vocabulary | NovaSeq 6000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 17 | PatternedFlowCell | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 18 | AssaySensitivity_Required_VAF | string / controlled vocabulary | 0.1 | Контролируемый входной параметр для детерминированных QC-правил. |
RunID,SampleID,ExpectedIndex_I7,ExpectedIndex_I5,AssignedReads,HoppedReads_Total,HoppedReads_FromHighAbundance,HoppingRate_Percent,MaxAcceptableHoppingRate_Percent,EstimatedContamination_Percent,MaxAcceptableContamination_Percent,TopDonorSample,DonorContribution_Percent,DualIndexUsed,UniqueDualIndex,Platform,PatternedFlowCell,AssaySensitivity_Required_VAF
RUN-2026-045,LB-PAT-001,ATTACTCG,TATAGCCT,25000000,12500,8500,0.05,0.5,0.02,0.1,LB-PAT-003,68.0,true,true,NovaSeq 6000,true,0.1
RUN-2026-045,LB-PAT-002,TCCGGAGA,TCCGGAGA,18000000,540000,420000,3.0,0.5,1.8,0.1,LB-PAT-005,78.0,true,false,NovaSeq 6000,true,0.1
RUN-2026-045,WES-SAMPLE-010,CGCTCATT,,45000000,180000,95000,0.4,0.5,0.25,0.1,WES-SAMPLE-008,53.0,false,false,NovaSeq 6000,true,5.0
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | RunID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | SampleID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | ExpectedIndex_I7 | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | ExpectedIndex_I5 | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | AssignedReads | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | HoppedReads_Total | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | HoppedReads_FromHighAbundance | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | HoppingRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | MaxAcceptableHoppingRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | EstimatedContamination_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | MaxAcceptableContamination_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | TopDonorSample | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | DonorContribution_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | DualIndexUsed | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | UniqueDualIndex | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | Platform | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | PatternedFlowCell | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | AssaySensitivity_Required_VAF | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | 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 | Применить правила для Index Hopping Contamination 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": "indexhoppingcontaminationchecker",
"utilityFolder": "IndexHoppingContaminationChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "RunID",
"value": "RUN-2026-045",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "SampleID",
"value": "LB-PAT-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "ExpectedIndex_I7",
"value": "ATTACTCG",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "ExpectedIndex_I5",
"value": "TATAGCCT",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "AssignedReads",
"value": "25000000",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "HoppedReads_Total",
"value": "12500",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "HoppedReads_FromHighAbundance",
"value": "8500",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "HoppingRate_Percent",
"value": "0.05",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "MaxAcceptableHoppingRate_Percent",
"value": "0.5",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "EstimatedContamination_Percent",
"value": "0.02",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "MaxAcceptableContamination_Percent",
"value": "0.1",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "TopDonorSample",
"value": "LB-PAT-003",
"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": "IndexHoppingContaminationChecker.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 и утверждёнными процедурами.