URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты IonTorrentRunAcceptanceChecker для сценария Ion Torrent Run Acceptance Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- • AQ20 Bases: Количество баз с качеством ≥Q20 — мера полезного выхода секвенирования.
- • Uniformity: Равномерность покрытия целевых регионов — критично для панелей ампликонного типа.
- ⚠️ ВАЖНО:
- • Ion Torrent имеет уникальный профиль ошибок: гомополимерные indels составляют >60% всех ошибок.
- • Поликлональность >30% необратимо снижает качество данных и не компенсируется глубиной.
- • Перегрузка чипа (ISP density > max) вызывает каскадное ухудшение всех метрик.
- ⚠️ КРИТИЧЕСКИ ВАЖНО:
- • Polyclonal ≤30%: Превышение = разбавление template или деградация ISPs.
- • AQ20 ≥ Min: Ниже порога = недостаточно данных для надежного variant calling.
- • Uniformity ≥80%: Для ампликонных панелей ниже 80% = проблемы с праймерами или PCR.
- • Raw Accuracy ≥98.5%: Ниже = деградация химии или изношенный чип.
- Критические параметры:
- • Polyclonal Rate: ≤ 30%
- • AQ20 Bases: ≥ Panel-specific minimum
- • Uniformity: ≥ 80%
- • On-Target Rate: ≥ 70%
- • Raw Accuracy: ≥ 98.5%
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для Ion Torrent Run Acceptance 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 | ION-2026-RUN-001 | Контролируемый входной параметр для детерминированных QC-правил. |
| 2 | ChipType | string / controlled vocabulary | 530 | Контролируемый входной параметр для детерминированных QC-правил. |
| 3 | PanelName | string / controlled vocabulary | Oncomine Comprehensive Assay v3 | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | ISP_Density_K_mm2 | decimal | 680 | Контролируемый входной параметр для детерминированных QC-правил. |
| 5 | MinISP_Density | decimal | 200 | Контролируемый входной параметр для детерминированных QC-правил. |
| 6 | MaxISP_Density | decimal | 1200 | Контролируемый входной параметр для детерминированных QC-правил. |
| 7 | Polyclonal_Percent | decimal | 18.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 8 | MaxPolyclonal_Percent | decimal | 30.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 9 | AQ20_Bases_Million | integer / decimal | 2800 | Контролируемый входной параметр для детерминированных QC-правил. |
| 10 | MinAQ20_Bases_Million | integer / decimal | 500 | Контролируемый входной параметр для детерминированных QC-правил. |
| 11 | Mean_Read_Length_bp | decimal | 185 | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | MinMeanReadLength_bp | decimal | 100 | Контролируемый входной параметр для детерминированных QC-правил. |
| 13 | Uniformity_Percent | decimal | 92.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 14 | MinUniformity_Percent | decimal | 80.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 15 | Duplication_Rate_Percent | decimal | 15.2 | Контролируемый входной параметр для детерминированных QC-правил. |
| 16 | MaxDuplication_Rate_Percent | decimal | 40.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 17 | On_Target_Rate_Percent | decimal | 88.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 18 | MinOnTarget_Rate_Percent | decimal | 70.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 19 | Raw_Accuracy_Percent | decimal | 99.4 | Контролируемый входной параметр для детерминированных QC-правил. |
| 20 | MinRawAccuracy_Percent | decimal | 98.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 21 | Total_Reads_Million | integer / decimal | 12 | Контролируемый входной параметр для детерминированных QC-правил. |
| 22 | MinTotal_Reads_Million | integer / decimal | 5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 23 | ControlSequence_Pass | string / controlled vocabulary | true | Контрольная точка/контрольный образец для валидности серии анализа. |
| 24 | Phasing_Score | decimal | 0.8 | pH; параметр стабильности, совместимости и пригодности серии. |
| 25 | MaxPhasing_Score | decimal | 1.5 | pH; параметр стабильности, совместимости и пригодности серии. |
RunID,ChipType,PanelName,ISP_Density_K_mm2,MinISP_Density,MaxISP_Density,Polyclonal_Percent,MaxPolyclonal_Percent,AQ20_Bases_Million,MinAQ20_Bases_Million,Mean_Read_Length_bp,MinMeanReadLength_bp,Uniformity_Percent,MinUniformity_Percent,Duplication_Rate_Percent,MaxDuplication_Rate_Percent,On_Target_Rate_Percent,MinOnTarget_Rate_Percent,Raw_Accuracy_Percent,MinRawAccuracy_Percent,Total_Reads_Million,MinTotal_Reads_Million,ControlSequence_Pass,Phasing_Score,MaxPhasing_Score
ION-2026-RUN-001,530,Oncomine Comprehensive Assay v3,680,200,1200,18.5,30.0,2800,500,185,100,92.5,80.0,15.2,40.0,88.0,70.0,99.4,98.5,12,5,true,0.8,1.5
ION-2026-RUN-002,520,AmpliSeq Cancer Hotspot v2,1350,200,1200,42.0,30.0,380,500,142,100,65.0,80.0,55.0,40.0,58.0,70.0,97.8,98.5,4,5,false,2.1,1.5
ION-2026-RUN-003,510,BRCA1/2 Panel,450,200,1200,28.0,30.0,620,500,165,100,82.0,80.0,35.0,40.0,75.0,70.0,99.1,98.5,6,5,true,1.2,1.5
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | RunID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | ChipType | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | PanelName | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | ISP_Density_K_mm2 | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | MinISP_Density | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | MaxISP_Density | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | Polyclonal_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | MaxPolyclonal_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | AQ20_Bases_Million | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | MinAQ20_Bases_Million | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | Mean_Read_Length_bp | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | MinMeanReadLength_bp | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | Uniformity_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | MinUniformity_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | Duplication_Rate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | MaxDuplication_Rate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | On_Target_Rate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | MinOnTarget_Rate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | Raw_Accuracy_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-020 | MinRawAccuracy_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-021 | Total_Reads_Million | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-022 | MinTotal_Reads_Million | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-023 | ControlSequence_Pass | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-024 | Phasing_Score | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-025 | MaxPhasing_Score | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | 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 | Применить правила для Ion Torrent Run Acceptance 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": "iontorrentrunacceptancechecker",
"utilityFolder": "IonTorrentRunAcceptanceChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "RunID",
"value": "ION-2026-RUN-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "ChipType",
"value": "530",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "PanelName",
"value": "Oncomine Comprehensive Assay v3",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "ISP_Density_K_mm2",
"value": "680",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "MinISP_Density",
"value": "200",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "MaxISP_Density",
"value": "1200",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "Polyclonal_Percent",
"value": "18.5",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "MaxPolyclonal_Percent",
"value": "30.0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "AQ20_Bases_Million",
"value": "2800",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "MinAQ20_Bases_Million",
"value": "500",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "Mean_Read_Length_bp",
"value": "185",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "MinMeanReadLength_bp",
"value": "100",
"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": "IonTorrentRunAcceptanceChecker.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 и утверждёнными процедурами.