URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты FragmentomicsQcChecker для сценария Fragmentomics QC Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- • Short Fragment Ratio: Соотношение коротких (<150 bp) к длинным фрагментам — маркер опухолевой ДНК.
- • Library Complexity: Количество уникальных молекул — определяет статистическую мощность анализа.
- • Motif Coverage: Глубина покрытия для анализа end-motifs — требует ≥10× для надежной детекции.
- ⚠️ ВАЖНО:
- • Адаптерные димеры (>2%) загрязняют данные и снижают эффективную глубину.
- ⚠️ КРИТИЧЕСКИ ВАЖНО:
- • Nucleosomal Peak ≥3.0: Слабый пик = потеря нуклеосомного позиционирования.
- • Adapter Dimer ≤2%: Выше этого уровня требуется повторная очистка библиотеки.
- • Motif Coverage ≥10×: Ниже этого порога анализ end-motifs статистически ненадежен.
- Критические параметры:
- • Nucleosomal Peak Height: ≥ 3.0
- • Adapter Dimer: ≤ 2%
- • Unique Molecules: ≥ 5M
- • Motif Coverage: ≥ 10×
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для Fragmentomics 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 | FRAG-2026-001 | Идентификатор образца или лабораторной пробы. |
| 2 | LibraryPrepMethod | string / controlled vocabulary | WGS | Метод или технологический подход; контролируемое справочное значение. |
| 3 | MedianInsertSize_bp | decimal | 168 | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | ExpectedMedianInsert_bp | decimal | 167 | Контролируемый входной параметр для детерминированных QC-правил. |
| 5 | InsertSizeTolerance_bp | decimal | 15 | Контролируемый входной параметр для детерминированных QC-правил. |
| 6 | ShortFragmentRatio | decimal | 0.28 | Отношение компонентов; структурный или рецептурный CQA. |
| 7 | MinShortFragmentRatio | decimal | 0.15 | Отношение компонентов; структурный или рецептурный CQA. |
| 8 | MaxShortFragmentRatio | decimal | 0.45 | Отношение компонентов; структурный или рецептурный CQA. |
| 9 | NucleosomalPeakHeight | decimal | 5.2 | Контролируемый входной параметр для детерминированных QC-правил. |
| 10 | MinNucleosomalPeakHeight | decimal | 3.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 11 | AdapterDimer_Percent | decimal | 0.3 | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | MaxAdapterDimer_Percent | decimal | 2.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 13 | UniqueMolecules_Million | integer / decimal | 18.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 14 | MinUniqueMolecules_Million | integer / decimal | 5.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 15 | MotifCoverage_X | decimal | 25.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 16 | MinMotifCoverage_X | decimal | 10.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 17 | BackgroundNoise_Score | decimal | 0.08 | Контролируемый входной параметр для детерминированных QC-правил. |
| 18 | MaxBackgroundNoise | decimal | 0.2 | Контролируемый входной параметр для детерминированных QC-правил. |
| 19 | OvertrimmingDetected | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
SampleID,LibraryPrepMethod,MedianInsertSize_bp,ExpectedMedianInsert_bp,InsertSizeTolerance_bp,ShortFragmentRatio,MinShortFragmentRatio,MaxShortFragmentRatio,NucleosomalPeakHeight,MinNucleosomalPeakHeight,AdapterDimer_Percent,MaxAdapterDimer_Percent,UniqueMolecules_Million,MinUniqueMolecules_Million,MotifCoverage_X,MinMotifCoverage_X,BackgroundNoise_Score,MaxBackgroundNoise,OvertrimmingDetected
FRAG-2026-001,WGS,168,167,15,0.28,0.15,0.45,5.2,3.0,0.3,2.0,18.5,5.0,25.0,10.0,0.08,0.2,false
FRAG-2026-002,Targeted,142,167,15,0.62,0.15,0.45,1.8,3.0,8.5,2.0,2.1,5.0,4.0,10.0,0.35,0.2,true
FRAG-2026-003,WGS,170,167,15,0.32,0.15,0.45,4.8,3.0,0.5,2.0,15.2,5.0,22.0,10.0,0.12,0.2,false
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | SampleID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | LibraryPrepMethod | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | MedianInsertSize_bp | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | ExpectedMedianInsert_bp | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | InsertSizeTolerance_bp | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | ShortFragmentRatio | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | MinShortFragmentRatio | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | MaxShortFragmentRatio | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | NucleosomalPeakHeight | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | MinNucleosomalPeakHeight | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | AdapterDimer_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | MaxAdapterDimer_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | UniqueMolecules_Million | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | MinUniqueMolecules_Million | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | MotifCoverage_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | MinMotifCoverage_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | BackgroundNoise_Score | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | MaxBackgroundNoise | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | OvertrimmingDetected | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | 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 | Применить правила для Fragmentomics 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": "fragmentomicsqcchecker",
"utilityFolder": "FragmentomicsQcChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "SampleID",
"value": "FRAG-2026-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "LibraryPrepMethod",
"value": "WGS",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "MedianInsertSize_bp",
"value": "168",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "ExpectedMedianInsert_bp",
"value": "167",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "InsertSizeTolerance_bp",
"value": "15",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "ShortFragmentRatio",
"value": "0.28",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "MinShortFragmentRatio",
"value": "0.15",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "MaxShortFragmentRatio",
"value": "0.45",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "NucleosomalPeakHeight",
"value": "5.2",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "MinNucleosomalPeakHeight",
"value": "3.0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "AdapterDimer_Percent",
"value": "0.3",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "MaxAdapterDimer_Percent",
"value": "2.0",
"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": "FragmentomicsQcChecker.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 и утверждёнными процедурами.