URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты McedClassifierQcChecker для сценария MCED Classifier QC Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- • cfDNA Input ≥ 10 ng: Достаточность материала для эпигеномического анализа.
- • CpG Coverage ≥ 30×: Глубина покрытия целевых сайтов метилирования.
- • Bisulfite Conversion ≥ 99%: Полнота химической конверсии (неполная = систематический артефакт).
- • Background Noise ≤ 0.15: Уровень фонового шума в данных.
- • Feature Completeness ≥ 90%: Доля успешно извлеченных признаков для модели.
- • Informative Fragments ≥ 5000: Количество фрагментов, несущих информацию о метилировании.
- • Tissue Confidence ≥ 0.70 (для положительных): Уверенность в предсказанной ткани.
- • Model Agreement ≥ 0.80: Согласованность между подмоделями ансамбля.
- • Hemolysis Index ≤ 50: Контаминация от лизиса лейкоцитов.
- ⚠️ ВАЖНО:
- 2. Бисульфитная конверсия: Мониторьте конверсию отдельно; при <99% весь батч подозрителен.
- 5. Тренды: Отслеживайте распределение cancer signal scores во времени для выявления model drift.
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для MCED Classifier 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 | SampleID | string / controlled vocabulary | MCED-2026-SCR-001 | Идентификатор образца или лабораторной пробы. |
| 2 | ClassifierName | string / controlled vocabulary | OncoDetect_MC | Биологический/молекулярный компонент, контролируемый как CQA. |
| 3 | ClassifierVersion | string / controlled vocabulary | v3.2 | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | CfDNA_Input_ng | decimal | 25.0 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 5 | MinCfDNA_Input_ng | decimal | 10 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 6 | CpG_Coverage_Mean_X | decimal | 48.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 7 | MinCpG_Coverage_X | decimal | 30 | Контролируемый входной параметр для детерминированных QC-правил. |
| 8 | BisulfiteConversion_Rate | decimal | 0.996 | Контролируемый входной параметр для детерминированных QC-правил. |
| 9 | MinBisulfiteConversion_Rate | decimal | 0.99 | Контролируемый входной параметр для детерминированных QC-правил. |
| 10 | FragmentSize_Peak_bp | decimal | 167 | Контролируемый входной параметр для детерминированных QC-правил. |
| 11 | FragmentProfile_Valid | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | BackgroundNoise_Score | decimal | 0.06 | Контролируемый входной параметр для детерминированных QC-правил. |
| 13 | MaxBackgroundNoise_Score | decimal | 0.15 | Контролируемый входной параметр для детерминированных QC-правил. |
| 14 | FeatureCompleteness_Percent | decimal | 97.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 15 | MinFeatureCompleteness_Percent | decimal | 90 | Контролируемый входной параметр для детерминированных QC-правил. |
| 16 | InformativeFragments_Count | integer / decimal | 22000 | Счётный показатель; используется для микробиологического, частичного или клеточного контроля. |
| 17 | MinInformativeFragments | decimal | 5000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 18 | CancerSignalScore | decimal | 0.92 | Контролируемый входной параметр для детерминированных QC-правил. |
| 19 | CancerSignalThreshold | decimal | 0.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 20 | PredictedTissue | string / controlled vocabulary | Lung | Контролируемый входной параметр для детерминированных QC-правил. |
| 21 | TissueConfidence | string / controlled vocabulary | 0.88 | Контролируемый входной параметр для детерминированных QC-правил. |
| 22 | MinTissueConfidence | string / controlled vocabulary | 0.70 | Контролируемый входной параметр для детерминированных QC-правил. |
| 23 | ModelAgreement_Score | decimal | 0.94 | Контролируемый входной параметр для детерминированных QC-правил. |
| 24 | MinModelAgreement_Score | decimal | 0.80 | Контролируемый входной параметр для детерминированных QC-правил. |
| 25 | PositiveControl_Pass | string / controlled vocabulary | true | Контрольная точка/контрольный образец для валидности серии анализа. |
| 26 | NegativeControl_Pass | string / controlled vocabulary | true | Контрольная точка/контрольный образец для валидности серии анализа. |
| 27 | PosControl_Score_Observed | decimal | 0.91 | Контрольная точка/контрольный образец для валидности серии анализа. |
| 28 | PosControl_Score_Expected_Min | integer / decimal | 0.8 | Контрольная точка/контрольный образец для валидности серии анализа. |
| 29 | NegControl_Score_Observed | decimal | 0.03 | Контрольная точка/контрольный образец для валидности серии анализа. |
| 30 | NegControl_Score_Expected_Max | decimal | 0.1 | Контрольная точка/контрольный образец для валидности серии анализа. |
| 31 | ArtifactDetected | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 32 | OvertrimmingDetected | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 33 | HemolysisIndex | decimal | 8 | Контролируемый входной параметр для детерминированных QC-правил. |
| 34 | MaxHemolysisIndex | decimal | 50 | Контролируемый входной параметр для детерминированных QC-правил. |
SampleID,ClassifierName,ClassifierVersion,CfDNA_Input_ng,MinCfDNA_Input_ng,CpG_Coverage_Mean_X,MinCpG_Coverage_X,BisulfiteConversion_Rate,MinBisulfiteConversion_Rate,FragmentSize_Peak_bp,FragmentProfile_Valid,BackgroundNoise_Score,MaxBackgroundNoise_Score,FeatureCompleteness_Percent,MinFeatureCompleteness_Percent,InformativeFragments_Count,MinInformativeFragments,CancerSignalScore,CancerSignalThreshold,PredictedTissue,TissueConfidence,MinTissueConfidence,ModelAgreement_Score,MinModelAgreement_Score,PositiveControl_Pass,NegativeControl_Pass,PosControl_Score_Observed,PosControl_Score_Expected_Min,NegControl_Score_Observed,NegControl_Score_Expected_Max,ArtifactDetected,OvertrimmingDetected,HemolysisIndex,MaxHemolysisIndex
MCED-2026-SCR-001,OncoDetect_MC,v3.2,25.0,10,48.0,30,0.996,0.99,167,true,0.06,0.15,97.5,90,22000,5000,0.92,0.5,Lung,0.88,0.70,0.94,0.80,true,true,0.91,0.8,0.03,0.1,false,false,8,50
MCED-2026-SCR-002,OncoDetect_MC,v3.2,18.0,10,22.0,30,0.972,0.99,145,false,0.28,0.15,72.0,90,3200,5000,0.45,0.5,Colon,0.52,0.70,0.55,0.80,false,true,0.42,0.8,0.05,0.1,true,true,65,50
MCED-2026-SCR-003,OncoDetect_MC,v3.2,30.0,10,55.0,30,0.998,0.99,168,true,0.04,0.15,98.2,90,28000,5000,0.03,0.5,None,0.0,0.70,0.97,0.80,true,true,0.89,0.8,0.02,0.1,false,false,5,50
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | SampleID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | ClassifierName | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | ClassifierVersion | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | CfDNA_Input_ng | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | MinCfDNA_Input_ng | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | CpG_Coverage_Mean_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | MinCpG_Coverage_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | BisulfiteConversion_Rate | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | MinBisulfiteConversion_Rate | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | FragmentSize_Peak_bp | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | FragmentProfile_Valid | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | BackgroundNoise_Score | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | MaxBackgroundNoise_Score | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | FeatureCompleteness_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | MinFeatureCompleteness_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | InformativeFragments_Count | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | MinInformativeFragments | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | CancerSignalScore | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | CancerSignalThreshold | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-020 | PredictedTissue | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-021 | TissueConfidence | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-022 | MinTissueConfidence | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-023 | ModelAgreement_Score | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-024 | MinModelAgreement_Score | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-025 | PositiveControl_Pass | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-026 | NegativeControl_Pass | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-027 | PosControl_Score_Observed | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-028 | PosControl_Score_Expected_Min | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-029 | NegControl_Score_Observed | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-030 | NegControl_Score_Expected_Max | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-031 | ArtifactDetected | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-032 | OvertrimmingDetected | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-033 | HemolysisIndex | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-034 | MaxHemolysisIndex | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | 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 | Применить правила для MCED Classifier 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": "mcedclassifierqcchecker",
"utilityFolder": "McedClassifierQcChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "SampleID",
"value": "MCED-2026-SCR-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "ClassifierName",
"value": "OncoDetect_MC",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "ClassifierVersion",
"value": "v3.2",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "CfDNA_Input_ng",
"value": "25.0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "MinCfDNA_Input_ng",
"value": "10",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "CpG_Coverage_Mean_X",
"value": "48.0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "MinCpG_Coverage_X",
"value": "30",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "BisulfiteConversion_Rate",
"value": "0.996",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "MinBisulfiteConversion_Rate",
"value": "0.99",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "FragmentSize_Peak_bp",
"value": "167",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "FragmentProfile_Valid",
"value": "true",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "BackgroundNoise_Score",
"value": "0.06",
"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": "McedClassifierQcChecker.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 и утверждёнными процедурами.