Описание утилиты: Bioinformatics Pipeline Version
Bioinformatics Pipeline Version Checker — Контроль версий биоинформатических пайплайнов
ℹ️ Утилита выполняет автоматическую верификацию программного окружения биоинформатических пайплайнов согласно требованиям CAP/CLIA и FDA Guidance on NGS-based Testing:
• Инструменты: Сверка версий aligners, variant callers и аннотаторов с валидированным манифестом.
• Базы данных: Контроль версий референсных геномов и баз знаний (ClinVar, COSMIC, gnomAD).
• Контейнеры: Проверка хешей Docker/Singularity образов для гарантии идентичности среды.
• Скрипты: Верификация версий кастомных скриптов (Python, R, Bash).
⚠️ ВАЖНО:
• Биоинформатический пайплайн является медицинским устройством (SaMD).
• Неавторизованное обновление даже минорной версии может изменить клинический результат.
Использование:
BioinformaticsPipelineVersionChecker.exe → демо-режим (вывод в консоль)
BioinformaticsPipelineVersionChecker.exe input.csv output.json → оценка ваших данных
Формат input.csv:
RunID,PipelineName,ComponentName,ActualVersion,ValidatedVersion,ComponentType
Пример:
RUN-001,OncoPanel_v3,GATK,4.2.6.1,4.2.6.1,Tool
📍 Область применения (Usage Where):
• Клинические NGS-лаборатории: Обязательная проверка перед каждым запуском пайплайна.
• Управление изменениями (Change Control): Документирование дрейфа версий.
• Аудит и инспекции: Доказательство воспроизводимости in silico анализа.
• CI/CD пайплайны: Автоматический gatekeeper перед деплоем в продакшн.
— ЗАЧЕМ ЭТО НУЖНО?
В отличие от «мокрых» реагентов, программное обеспечение меняется незаметно.
Автоматическая проверка версий исключает риск использования невалидированного кода.
Это фундаментальное требование Data Integrity и Patient Safety в эпоху Precision Medicine.
⚠️ КРИТИЧЕСКИ ВАЖНО:
• Exact Match: Для клинических тестов требуется точное совпадение версий, не «совместимость».
• Database Versions: Обновление ClinVar без ревалидации может реклассифицировать варианты.
• Container Hash: Версия тега Docker (latest) недостаточна; нужен SHA256 digest.
• Audit Trail: Каждая проверка должна логироваться с timestamp и operator ID.
Ключевые особенности утилиты:
• Построчная сверка каждого компонента пайплайна
• Поддержка различных типов компонентов (Tool, DB, Script, Container)
• Мгновенная блокировка при несоответствии
• Генерация детального отчета о расхождениях
• Соответствие требованиям CAP Molecular Pathology Checklist
Критические параметры:
• Actual Version: Должна точно совпадать с Validated Version
• Component Coverage: Все критические компоненты должны быть проверены
• Database Date: Актуальность референсных данных
💡 Советы по использованию:
1. Манифест: Ведите централизованный YAML/JSON манифест валидированных версий.
2. Контейнеризация: Используйте Docker/Singularity для фиксации окружения.
3. Автоматизация: Интегрируйте чекер в начало Nextflow/Snakemake пайплайна.
4. Ревавалидация: При обновлении версии запускайте полный протокол ревалидации.
5. Документирование: Сохраняйте JSON-отчеты как часть аудиторского следа каждого запуска.
⚠️ Примечание: Данная утилита является инструментом Software Quality Assurance. Она не заменяет функциональную валидацию пайплайна, но гарантирует, что используется именно та версия, которая была валидирована.
input.csv
RunID,PipelineName,ComponentName,ActualVersion,ValidatedVersion,ComponentType
NGS-RUN-2026-001,OncoPanel_v3,BWA-MEM,0.7.17-r1188,0.7.17-r1188,Tool
NGS-RUN-2026-001,OncoPanel_v3,GATK,4.2.6.1,4.2.6.1,Tool
NGS-RUN-2026-001,OncoPanel_v3,ClinVar,2026-05-01,2026-05-01,Database
NGS-RUN-2026-002,OncoPanel_v3,Samtools,1.19,1.17,Tool
NGS-RUN-2026-002,OncoPanel_v3,VEP,110,110,Tool
URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты BioinformaticsPipelineVersionChecker для сценария Bioinformatics Pipeline Version Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- ⚠️ ВАЖНО:
- ⚠️ КРИТИЧЕСКИ ВАЖНО:
- Критические параметры:
- • Component Coverage: Все критические компоненты должны быть проверены
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для Bioinformatics Pipeline Version 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 | NGS-RUN-2026-001 | Контролируемый входной параметр для детерминированных QC-правил. |
| 2 | PipelineName | string / controlled vocabulary | OncoPanel_v3 | Контролируемый входной параметр для детерминированных QC-правил. |
| 3 | ComponentName | string / controlled vocabulary | BWA-MEM | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | ActualVersion | string / controlled vocabulary | 0.7.17-r1188 | Контролируемый входной параметр для детерминированных QC-правил. |
| 5 | ValidatedVersion | string / controlled vocabulary | 0.7.17-r1188 | Контролируемый входной параметр для детерминированных QC-правил. |
| 6 | ComponentType | string / controlled vocabulary | Tool | Контролируемый входной параметр для детерминированных QC-правил. |
RunID,PipelineName,ComponentName,ActualVersion,ValidatedVersion,ComponentType
NGS-RUN-2026-001,OncoPanel_v3,BWA-MEM,0.7.17-r1188,0.7.17-r1188,Tool
NGS-RUN-2026-001,OncoPanel_v3,GATK,4.2.6.1,4.2.6.1,Tool
NGS-RUN-2026-001,OncoPanel_v3,ClinVar,2026-05-01,2026-05-01,Database
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | RunID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | PipelineName | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | ComponentName | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | ActualVersion | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | ValidatedVersion | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | ComponentType | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | 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 | Применить правила для Bioinformatics Pipeline Version 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": "bioinformaticspipelineversionchecker",
"utilityFolder": "BioinformaticsPipelineVersionChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "RunID",
"value": "NGS-RUN-2026-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "PipelineName",
"value": "OncoPanel_v3",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "ComponentName",
"value": "BWA-MEM",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "ActualVersion",
"value": "0.7.17-r1188",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "ValidatedVersion",
"value": "0.7.17-r1188",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "ComponentType",
"value": "Tool",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
}
],
"criticalFindings": [],
"warnings": [],
"audit": {
"inputHash": "sha256:<calculated at runtime>",
"rulesVersion": "<utility executable version>",
"documentation": "BioinformaticsPipelineVersionChecker.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 и утверждёнными процедурами.