LivingPark utils

一组编写LivingPark笔记本的实用函数。

使用示例

import livingpark_utils
from livingpark_utils import download
from livingpark_utils.clinical import moca2mmse
from livingpark_utils.dataset import ppmi

utils = livingpark_utils.LivingParkUtils()
downloader = download.ppmi.Downloader(utils.study_files_dir)

utils.notebook_init()
utils.get_study_files(["Demographics.csv"], default=downloader)
utils.get_T1_nifti_files(
    cohort, default=downloader
)  # `cohort` is of type: pd.DataFrame

ppmi.find_nifti_file_in_cache(x["PATNO"], x["EVENT_ID"], x["Description"])
ppmi.disease_duration()

moca2mmse(2)

在不泄露患者信息的情况下排除队列中的受试者。

from livingpark_utils.ignore import (
    insert_hash,
    remove_ignored,
)

# Assuming a cohort definition defined as `cohort`.
cohort = insert_hash(cohort, columns=["PATNO", "EVENT_ID", "Description"])
remove_ignored(cohort, ignore_file=".ppmiignore")

执行实用笔记本的使用

from livingpark_utils.scripts import run

run.mri_metadata()
run.pd_status()

注意：可选地使用%%capture单元格魔法进一步隐藏笔记本输出。

CLI命令

使用队列定义文件下载T1 nifti文件。

$ get_T1_nifti_files <cohort_file> --downloader (ppmi) [--symlink=<bool>]
[--force=<bool>] [--timeout=<int>]

cohort_file是事先创建的csv文件。根据选择的下载器，它必须具有以下列

• PPMI: PATNO、EVENT_ID和描述。

故障排除

Windows上的权限问题

我们在创建缓存数据文件夹时使用符号链接。不幸的是，默认情况下，Windows不允许用户创建符号链接。要在您的机器上修复此问题，请参阅此博客文章中的指南。

贡献指南

我们欢迎以Pull-Request的形式向此存储库贡献任何类型的贡献。另请参阅LivingPark贡献指南。

请确保

• 使用Python类型注解
• 使用numpydoc格式为所有函数包含Python文档字符串
• 格式化文档字符串
• 在修改文件时运行psf/black
• 在提交之前运行pre-commit run --all，这将检查您的PR