create a citation file for a BIDS dataset
Project description
bids2cite
Create a citation file for a BIDS dataset.
Can also be used to update references, authors and add license to a dataset.
Installation
git clone https://github.com/Remi-Gau/bids2cite.git
cd bids2cite
pip install .
For developers
pip install .[dev]
Basic tests can be run with:
make test
make test-cli
Usage
The most basic usage is:
bids2cite path_to_bids_dataset
An example of call with all the options:
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
and --description
allow you to pass keywords and description to
add to the citation file.
--skip-prompt
is set to false
(default) to prompt you for information to add
to the citation file.
--authors_file
points to a TSV file containing potential authors to add
citation file. This can be useful if you need to have a single file to keep
track of several lab members and only pick the relevant ones to add to a given
dataset.
This TSV file must at least have first_name
and last_name
columns, but can
also include ORCID
and affiliation
columns.
first_name | last_name | ORCID | affiliation |
---|---|---|---|
Rémi | Gau | 0000-0002-1535-9767 | UCLouvain |
Mohamed | Rezk | 0000-0002-1866-8645 | UCLouvain |
There is a sample TSV in the inputs folder.
Type the following for more info on how to run it:
bids2cite --help
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for bids2cite-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 252ee5085b4d345ce231fe91f93ecb7840791b222571e81427b1e22ed6264cd7 |
|
MD5 | f2cd5386ab6c1602bf63d216ee649262 |
|
BLAKE2b-256 | 52b7f36d6d5c8709f22ccebe04c955dd839bf43935ebbb255e9e503cb83cfc12 |