URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты MethylationPanelRunQcChecker для сценария Methylation Panel Run QC Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- БИСУЛЬФИТНАЯ КОНВЕРСИЯ (КРИТИЧЕСКИЙ ПАРАМЕТР):
- • Conversion Rate ≥ 99%: Доля C→T в не-CpG контексте. Ниже = неполная конверсия.
- • Non-CpG C Retention ≤ 1%: Прямой индикатор неконвертированных цитозинов.
- • Q30 ≥ 70%: Сниженный порог из-за уменьшенной сложности библиотеки после конверсии.
- • Mean Target Depth ≥ 100×: Достаточная глубина для количественной оценки метилирования.
- • On-Target ≥ 50%: Сниженный порог из-за снижения специфичности гибридизации после BS.
- • Uniformity ≥ 70%: Учитывает ожидаемый GC-bias от бисульфитной обработки.
- • Duplication Rate ≤ 60%: Повышенный порог — BS-seq имеет естественно высокую дупликацию.
- • Unique Molecules ≥ 10 000: Минимальная сложность библиотеки.
- • Library Complexity Score ≥ 0.5: Интегральная оценка разнообразия.
- • CpG Completeness ≥ 85%: Доля целевых CpG-сайтов с достаточным покрытием.
- • Fully Methylated Control ≥ 95%: Подтверждение способности детектировать метилирование.
- • Unmethylated Control ≤ 5%: Подтверждение отсутствия фонового сигнала.
- ⚠️ ВАЖНО:
- 5. Fragment Size: Пик ~165 bp нормален для cfDNA; смещение <150 bp указывает на пере-деградацию.
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для Methylation Panel 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 | METHYL-RUN-2026-001 | Контролируемый входной параметр для детерминированных QC-правил. |
| 2 | PanelName | string / controlled vocabulary | EpiMark_500 | Контролируемый входной параметр для детерминированных QC-правил. |
| 3 | Platform | string / controlled vocabulary | NovaSeq 6000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | ConversionMethod | string / controlled vocabulary | Bisulfite | Метод или технологический подход; контролируемое справочное значение. |
| 5 | BisulfiteConversion_Rate | decimal | 0.997 | Контролируемый входной параметр для детерминированных QC-правил. |
| 6 | MinConversion_Rate | decimal | 0.99 | Контролируемый входной параметр для детерминированных QC-правил. |
| 7 | NonCpG_CytosineRetention_Percent | decimal | 0.3 | Контролируемый входной параметр для детерминированных QC-правил. |
| 8 | MaxNonCpG_Retention_Percent | decimal | 1.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 9 | PercentQ30 | decimal | 82.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 10 | MinQ30 | decimal | 70 | Контролируемый входной параметр для детерминированных QC-правил. |
| 11 | MeanTargetDepth_X | string / controlled vocabulary | 250 | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | MinMeanTargetDepth_X | string / controlled vocabulary | 100 | Контролируемый входной параметр для детерминированных QC-правил. |
| 13 | OnTargetRate_Percent | decimal | 72.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 14 | MinOnTargetRate_Percent | decimal | 50 | Контролируемый входной параметр для детерминированных QC-правил. |
| 15 | Uniformity_Percent | decimal | 85.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 16 | MinUniformity_Percent | decimal | 70 | Контролируемый входной параметр для детерминированных QC-правил. |
| 17 | DuplicationRate_Percent | decimal | 35.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 18 | MaxDuplicationRate_Percent | decimal | 60 | Контролируемый входной параметр для детерминированных QC-правил. |
| 19 | CpG_Sites_Covered | decimal | 48500 | Контролируемый входной параметр для детерминированных QC-правил. |
| 20 | CpG_Sites_Target_Total | decimal | 50000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 21 | CpG_Coverage_Completeness_Percent | decimal | 97.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 22 | MinCpG_Completeness_Percent | decimal | 85 | Контролируемый входной параметр для детерминированных QC-правил. |
| 23 | FragmentSize_Peak_bp | decimal | 165 | Контролируемый входной параметр для детерминированных QC-правил. |
| 24 | FragmentProfile_Valid | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 25 | FullyMethylated_Control_Pass | string / controlled vocabulary | true | Контрольная точка/контрольный образец для валидности серии анализа. |
| 26 | FullyMethylated_Control_Level | string / controlled vocabulary | 0.98 | Контрольная точка/контрольный образец для валидности серии анализа. |
| 27 | MinFullyMethylated_Level | decimal | 0.95 | Контролируемый входной параметр для детерминированных QC-правил. |
| 28 | Unmethylated_Control_Pass | string / controlled vocabulary | true | Контрольная точка/контрольный образец для валидности серии анализа. |
| 29 | Unmethylated_Control_Level | string / controlled vocabulary | 0.02 | Контрольная точка/контрольный образец для валидности серии анализа. |
| 30 | MaxUnmethylated_Level | decimal | 0.05 | Контролируемый входной параметр для детерминированных QC-правил. |
| 31 | NTC_Pass | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 32 | UniqueMolecules_Count | integer / decimal | 85000 | Счётный показатель; используется для микробиологического, частичного или клеточного контроля. |
| 33 | MinUniqueMolecules | decimal | 10000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 34 | LibraryComplexity_Score | decimal | 0.78 | Контролируемый входной параметр для детерминированных QC-правил. |
| 35 | MinLibraryComplexity_Score | decimal | 0.5 | Контролируемый входной параметр для детерминированных QC-правил. |
RunID,PanelName,Platform,ConversionMethod,BisulfiteConversion_Rate,MinConversion_Rate,NonCpG_CytosineRetention_Percent,MaxNonCpG_Retention_Percent,PercentQ30,MinQ30,MeanTargetDepth_X,MinMeanTargetDepth_X,OnTargetRate_Percent,MinOnTargetRate_Percent,Uniformity_Percent,MinUniformity_Percent,DuplicationRate_Percent,MaxDuplicationRate_Percent,CpG_Sites_Covered,CpG_Sites_Target_Total,CpG_Coverage_Completeness_Percent,MinCpG_Completeness_Percent,FragmentSize_Peak_bp,FragmentProfile_Valid,FullyMethylated_Control_Pass,FullyMethylated_Control_Level,MinFullyMethylated_Level,Unmethylated_Control_Pass,Unmethylated_Control_Level,MaxUnmethylated_Level,NTC_Pass,UniqueMolecules_Count,MinUniqueMolecules,LibraryComplexity_Score,MinLibraryComplexity_Score
METHYL-RUN-2026-001,EpiMark_500,NovaSeq 6000,Bisulfite,0.997,0.99,0.3,1.0,82.0,70,250,100,72.0,50,85.0,70,35.0,60,48500,50000,97.0,85,165,true,true,0.98,0.95,true,0.02,0.05,true,85000,10000,0.78,0.5
METHYL-RUN-2026-002,EpiMark_500,NovaSeq 6000,Bisulfite,0.965,0.99,3.5,1.0,68.0,70,80,100,45.0,50,58.0,70,72.0,60,32000,50000,64.0,85,140,false,false,0.82,0.95,false,0.12,0.05,true,5200,10000,0.32,0.5
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | RunID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | PanelName | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | Platform | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | ConversionMethod | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | BisulfiteConversion_Rate | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | MinConversion_Rate | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | NonCpG_CytosineRetention_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | MaxNonCpG_Retention_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | PercentQ30 | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | MinQ30 | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | MeanTargetDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | MinMeanTargetDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | OnTargetRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | MinOnTargetRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | Uniformity_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | MinUniformity_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | DuplicationRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | MaxDuplicationRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | CpG_Sites_Covered | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-020 | CpG_Sites_Target_Total | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-021 | CpG_Coverage_Completeness_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-022 | MinCpG_Completeness_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-023 | FragmentSize_Peak_bp | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-024 | FragmentProfile_Valid | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-025 | FullyMethylated_Control_Pass | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-026 | FullyMethylated_Control_Level | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-027 | MinFullyMethylated_Level | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-028 | Unmethylated_Control_Pass | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-029 | Unmethylated_Control_Level | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-030 | MaxUnmethylated_Level | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-031 | NTC_Pass | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-032 | UniqueMolecules_Count | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-033 | MinUniqueMolecules | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-034 | LibraryComplexity_Score | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-035 | MinLibraryComplexity_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 | Применить правила для Methylation Panel 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": "methylationpanelrunqcchecker",
"utilityFolder": "MethylationPanelRunQcChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "RunID",
"value": "METHYL-RUN-2026-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "PanelName",
"value": "EpiMark_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": "ConversionMethod",
"value": "Bisulfite",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "BisulfiteConversion_Rate",
"value": "0.997",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "MinConversion_Rate",
"value": "0.99",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "NonCpG_CytosineRetention_Percent",
"value": "0.3",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "MaxNonCpG_Retention_Percent",
"value": "1.0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "PercentQ30",
"value": "82.0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "MinQ30",
"value": "70",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "MeanTargetDepth_X",
"value": "250",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "MinMeanTargetDepth_X",
"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": "MethylationPanelRunQcChecker.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 и утверждёнными процедурами.