Шаблон отчёта о расчёте размера выборки

Шаблон предназначен для подготовки стандартизированного параметризированного отчёта о расчёте размера выборки в клиническом исследовании или научно-исследовательской работе. Он использует систему научно-технической документации Quarto и язык разметки Typst для вывода итогового документа в формате PDF.

Состав шаблона:

.
├── acronyms.typ              # используемые сокращения
├── template.qmd              # основной файл шаблона отчёта
├── typst-show.typ            # файл, связывающий qmd, стили typst и метаданные
├── typst-template.typ        # вёрстка и стили документа 
└── vancouver-brackets.csl    # стиль оформления библиографических ссылок и списка литературы

Помимо указанных файлов проект должен дополнительно содержать файлы:

• _quarto.yml — файл проекта Quarto;
• _variables.yml — метаданные исследования: название, спонсор и проектная команда, описание ИЛП…;
• references.bib — библиографические источники;
• sample-size.R — программа для вычисления размера выборки и создания диаграммы потока пациентов. Выполняется при рендере файла отчёта.

Использование

Типичный сценарий использования:

1. Создать локально директорию проекта и открыть её в IDE.
2. Создать шаблон проекта с помощью пакета {fmisc}:

# renv::install("git::https://git.mikebartov.ru/Feron/fmisc.git")
fmisc::setup_study()

3. В корневой директории проекта выполнить:

# Для использования актуальной версии шаблона отчёта укажите самый поздний тег
quarto use template https://git.mikebartov.ru/mbartov/samplesize-report/archive/v0.2.zip

Когда Quarto спросит, создавать ли поддиректорию для шаблона, ответьте “Yes” и укажите имя директории 11_Statistics/11.01_Statistics-Oversight/11.01.02_Sample-Size-Calculation. Это скопирует файлы шаблона в указанную директорию, а основной файл шаблона отчёта будет автоматически назван по имени содержащей его директории — 11.01.02_Sample-Size-Calculation.qmd. Для удобства можно присвоить файлу отчёта более короткое имя, напр. sample-size-report.qmd.