PyCap 技术文档

1. 安装指南

PyCap 可以通过 pip 进行安装。以下是安装最新版本的命令：

$ pip install PyCap

如果您需要将 REDCap 数据加载到 pandas 数据框架中，可以使用以下命令安装包含 pandas 的完整版本：

$ pip install PyCap[all]

要从 GitHub 仓库安装最新的开发版本，请使用以下命令：

$ pip install -e git+https://github.com/redcap-tools/PyCap.git#egg=PyCap

2. 项目的使用说明

PyCap 是一个 Python 模块，它通过一些有用的抽象公开了 REDCap API。有关 REDCap 项目的更多信息可以在 这里 找到。

PyCap 的官方文档和使用示例可以在 这里 查看。

3. 项目API使用文档

PyCap 目前支持以下 API 调用：

导出 (Export)

• Arms
• 数据访问组 (Data Access Groups)
• 事件 (Events)
• 字段名称 (Field names)
• 仪器 (Instruments)
• 仪器-事件映射 (Instrument-event mapping)
• 文件 (File)
• 日志 (Logging)
• 元数据 (Metadata)
• 项目信息 (Project Info)
• 仪器的 PDF
• 记录 (Records)
• 重复仪器和事件 (Repeating instruments and events)
• 报告 (Report)
• 调查参与者列表 (Survey participant list)
• 用户 (Users)
• 用户-数据访问组分配 (User-DAG assignment)
• 用户角色 (User Roles)
• 用户-角色分配 (User-Role assignment)
• 版本 (Version)

导入 (Import)

• Arms
• 数据访问组 (Data Access Groups)
• 事件 (Events)
• 文件 (File)
• 仪器-事件映射 (Instrument-event mapping)
• 元数据 (Metadata)
• 记录 (Records)
• 重复仪器和事件 (Repeating instruments and events)
• 用户 (Users)
• 用户-数据访问组分配 (User-DAG assignment)
• 用户角色 (User Roles)
• 用户-角色分配 (User-Role assignment)

删除 (Delete)

• Arms
• 数据访问组 (Data Access Groups)
• 事件 (Events)
• 文件 (File)
• 记录 (Records)
• 用户 (Users)
• 用户角色 (User Roles)

其他 (Other)

• 生成下一个记录名 (Generate next record name)
• 切换数据访问组 (Switch data access group)

4. 项目安装方式

PyCap 的安装方式已在“安装指南”部分详细说明。您可以通过 pip 安装最新版本或从 GitHub 仓库安装开发版本。请确保您的环境中已安装 pip。