bids2cite

为BIDS数据集创建引用文件。

也可用于更新引用、作者和添加许可证到数据集。

安装

git clone https://github.com/Remi-Gau/bids2cite.git
cd bids2cite
pip install .

对于开发者

pip install .[dev]

基本测试可以使用

make test
make test-cli

用法

最基本的使用方法是

bids2cite path_to_bids_dataset

带有所有选项的调用示例

bids2cite "tests/bids" \
    --keywords "foo, bar, me" \
    --description "this is the description of my dataset" \
    --authors_file "inputs/authors.tsv" \
    --skip-prompt false \
    --verbosity INFO

--keywords 和 --description 允许您将关键字和描述传递到要添加到引用文件的引用中。

--skip-prompt 设置为 false（默认）以提示您添加到引用文件的信息。

--authors_file 指向包含要添加到引用文件的潜在作者的TSV文件。如果您需要有一个文件来跟踪多个实验室成员，并且只想选择添加到特定数据集的相关成员，这将很有用。

此TSV文件至少应包含 first_name 和 last_name 列，但也可以包含 ORCID 和 affiliation 列。

在inputs文件夹中有一个示例TSV。

输入以下内容以获取有关如何运行的更多信息

bids2cite --help