Usage Notes

bids2cite takes as principal input the path of the BIDS dataset where the dataset description file is located. The dataset description file is a JSON file named dataset_description.json that is located in the root of the BIDS dataset.

More information about the command line arguments can be found by typing:

bids2cite --help

Command-Line Arguments

BIDS app to create citation file for your BIDS dataset.

usage: bids2cite [-h] [-o OUTPUT_FORMAT] [-d DESCRIPTION] [-k KEYWORDS]
                 [-l LICENSE] [-s] [--authors-file AUTHORS_FILE] [--verbose]
                 [--version]
                 bids_dir

Positional Arguments

bids_dir

The directory with the input dataset formatted according to the BIDS standard.

Named Arguments

-o, --output-format

Choose the output format between ‘citation’ for CITATION.cff

and ‘datacite’ for datacite.yml.

Default: 'datacite'

-d, --description

Description to add to the dataset.

Default: ''

-k, --keywords

List of key words separated by commas to add to the citation file.

Default: ''

-l, --license

License to add to choose from: [‘CC0-1.0’, ‘CC-BY-NC-SA-4.0’, ‘PDDL-1.0’, ‘None’]

-s, --skip-prompt

If you do not want to use the prompt interface.

Default: False

--authors-file

.tsv file containing list of potential new authors with the columns:

first_name, last_name, ORCID (optional), affiliation (optional)

Default: ''

--verbose, -v

--version

show program’s version number and exit

For a more readable version of this help section, see the online “.