BEP032 工具

此仓库收集支持BEP032 提案的工具。它最初以 AnDO (Animal Data Organization) 的名称出现，并汇集了一套便于使用所提议结构的工具。有关BIDS本身的文档，请参阅https://bids-specification.readthedocs.io。该提案欢迎社区任何类型的反馈，我们欢迎所有建设性的评论。

提供的与BEP032集成的工具包括

• BEP032Validator 脚本，用于检查您的数据集是否遵循当前的BEP032规则

• BEP032Generator 脚本用于创建与 BEP032 兼容的文件夹结构，对于给定的一组主题和会话，不包含元数据文件。这些文件需要在输入 CSV 文件中列出。

• BEP032Templater 脚本用于生成与 BEP032 兼容的文件夹结构，包括需要手动扩展的虚拟文件，例如使用 Excel 或文本编辑器。

• BEP032Viewer 脚本用于以方便的方式显示您的数据集目录。（已弃用）

官方文档托管在 ReadTheDocs。

安装

依赖关系

BEP032Validator 需要

• Python (>= 3.7)
• Pip3

用户安装

要包含 BEP032 工具所需的所有软件包，请从 https://github.com/INT-NIT/BEP032tools 下载存储库，并在解压缩的存储库版本中运行以下命令

>  pip install BEP032tools[tools]

通过安装 BEP032Validator，将安装以下脚本

BEP032Validator 脚本的一般用法

usage: BEP032Validator.py [-h] [-v] path

positional arguments:
  path           Path to your folder

optional arguments:  -h, --help     show this help message and exit
  -v, --verbose  increase output verbosity

特定用法

验证器可以直接从命令行界面（CLI）使用

> BEP032Validator -v tests/dataset001/Landing

或从 Python 内部使用

> from bep032tools.validator import BEP032Validator
> BEP032Validator.is_valid('tests/dataset001/Landing')

Generator 脚本的一般用法

生成器可以用于根据会话和主题列表创建与 BEP032 兼容的文件夹结构（不包含元数据文件）。此会话和主题列表必须以 CSV 文件的形式提供

usage: BEP032Generator.py [-h] pathToCsv pathToDir

positional arguments:
  pathToCsv   Path to your folder
  pathToDir   Path to your csv file

optional arguments:
  -h, --help  show this help message and exit

生成器可以直接从命令行界面（CLI）使用

> BEP032Generator data.csv data/

Templater 脚本的一般用法

usage: BEP032Temlater.py [-h] pathToCsv pathToDir

positional arguments:
  pathToCsv   Path to your folder
  pathToDir   Path to your csv file

optional arguments:
  -h, --help  show this help message and exit

Templater 可以直接从命令行界面（CLI）使用

> BEP032Templater data.csv data/

如何创建包含自定义元数据的 BEP032 结构

有两种方式可以将自定义元数据（文件）添加到 BEP032 结构中

1. 使用 BEP032Templator 生成包含虚拟元数据文件的结构，并在这些文件中手动输入元数据。
2. 程序化扩展 BEP032Generator。为此，您需要创建一个继承自 bep032tools.generator.BE032Generator 的 Python 类，并实现缺失的元数据方法
   • generate_metadata_file_sessions
   • generate_metadata_file_tasks
   • generate_metadata_file_dataset_description
   • generate_metadata_file_participants
   • generate_metadata_file_probes
   • generate_metadata_file_probes
   • generate_metadata_file_channels
   • generate_metadata_file_contacts
   • generate_metadata_file_scans

这些方法应该从您项目特定的位置获取相应的元数据信息，并使用 generator.utils.save_json 和 generator.utils.save_tsv 函数分别创建相应的 CSV 或 JSON 文件。当所有缺失的方法都实现后，generator.BEP032Generator.generate_struct() 不仅会创建相应的文件夹结构，还会创建所有包含元数据的元数据文件。

安装问题

在某些情况下，pandas 可能无法通过 pip 正确安装。在这种情况下，我们建议通过 conda 安装 pandas。

开发

我们欢迎所有经验水平的新贡献者。

重要链接

• 官方源代码存储库： https://github.com/INT-NIT/BEP032tools
• （计划中）下载发布： https://pypi.ac.cn/project/BEP032tools/
• 问题跟踪器：https://github.com/INT-NIT/BEP032tools/issues

贡献

要为 BEP032tools 的开发做出贡献，请打开 问题 或 pull request，或直接在 BEP032 建议书 中评论。