Reproschema Python库和命令行界面（CLI）

安装

reproschema需要Python 3.10及以上版本。

pip install reproschema

开发者安装

在您创建分支后，您可以以开发者模式克隆并安装repo。

git clone https://github.com/<your github>/reproschema-py.git
cd reproschema-py
pip install -e .[dev]

风格

此存储库使用pre-commit来检查风格。

• 使用pip安装pre-commit： pip install pre-commit
• 为了在第一次使用时与存储库一起使用，您必须在根目录中运行run pre-commit install。

当使用pre-commit时，您可能需要运行git commit两次，因为pre-commit可能会对您的代码进行额外的更改以进行风格检查，并且默认情况下不会提交这些更改。

CLI使用

此软件包安装了reproschema命令行界面（CLI）。

$ reproschema --help

$  A client to support interactions with ReproSchema

  To see help for a specific command, run

  reproschema COMMAND --help     e.g. reproschema validate --help

Options:
  --version
  -l, --log-level [DEBUG|INFO|WARNING|ERROR|CRITICAL]
                                  Log level name  [default: INFO]
  --help                          Show this message and exit.

Commands:
  convert             Converts a path to a different format, jsonld,...
  create
  migrate             Updates to a new reproschema version
  redcap2reproschema  Converts REDCap CSV files to Reproschema format.
  reproschema2redcap  Converts reproschema protocol to REDCap CSV format.
  serve
  validate            Validates if the path has a valid reproschema format

reproschema2redcap

CLI使用

您可以直接从命令行使用此功能。要将ReproSchema协议转换为REDCap CSV格式，请使用以下命令

reproschema reproschema2redcap <input_dir_path> <output_csv_filename>

• <input_dir_path>：协议根目录的路径。例如，要将ReproNim提供的reproschema-demo-protocol进行转换，可以使用以下命令

  git clone https://github.com/ReproNim/reproschema-demo-protocol.git
  cd reproschema-demo-protocol
  pwd
  

  在这种情况下，pwd命令的输出（显示您的当前目录路径）应该是您的<input_dir_path>。
• <output_csv_filename>：转换后的数据将保存的输出CSV文件的名称。

Python函数使用

您也可以在Python代码中使用reproschema-py包中的reproschema2redcap函数。

from reproschema import reproschema2redcap

input_dir_path = "path-to/reproschema-demo-protocol"
output_csv_filename = "output.csv"

reproschema2redcap(input_dir_path, output_csv_filename)

redcap2reproschema

redcap2reproschema函数旨在处理给定的REDCap CSV文件和YAML配置，以生成reproschema格式的输出。

先决条件

在转换之前，请确保您有以下内容

YAML配置文件:

• 下载templates/redcap2rs.yaml并填写您的协议详细信息。

YAML文件配置

在templates/redcap2rs.yaml文件中，提供以下信息

• protocol_name：这是您协议的唯一标识符。使用下划线代替空格，并避免特殊字符。
• protocol_display_name：将在应用程序中显示的名称。
• protocol_description：您协议的简要描述。

示例

protocol_name: "My_Protocol"
protocol_display_name: "Assessment Protocol"
protocol_description: "This protocol is for assessing cognitive skills."

CLI使用

`redcap2reproschema`函数已集成到CLI工具中，使用以下命令

reproschema redcap2reproschema path/to/your_redcap_data_dic.csv path/to/your_redcap2rs.yaml

可选地，您可以通过添加选项：--output-path PATH提供输出目录的路径（默认为当前目录）

Python函数使用

您也可以在Python代码中使用reproschema-py包中的redcap2reproschema函数。

from reproschema import redcap2reproschema

csv_path = "path-to/your_redcap_data_dic.csv"
yaml_path = "path-to/your_redcap2rs.yaml"
output_path = "path-to/directory_you_want_to_save_output"

reproschema2redcap(csv_file, yaml_file, output_path)

注意

1. 该脚本需要有效的互联网连接以访问GitHub存储库。