Skip to content

feat: add Python script to automate dataset_description.json generation - #422

Open
sejalpunwatkar wants to merge 2 commits into
bids-standard:mainfrom
sejalpunwatkar:main
Open

feat: add Python script to automate dataset_description.json generation#422
sejalpunwatkar wants to merge 2 commits into
bids-standard:mainfrom
sejalpunwatkar:main

Conversation

@sejalpunwatkar

Copy link
Copy Markdown

Summary

This PR introduces a Python utility script designed to automate the creation of the dataset_description.json file, a core requirement for BIDS-compliant datasets.

Key Features

  • Path Automation: Dynamically generates the correct file path by combining the root_dir and project_label.
  • Standardization: Uses a clean metadata template to ensure the output matches official BIDS specifications.
  • Organization: Prevents common manual entry errors and helps maintain project structure during large-scale data conversions.

Why this is needed

Manually creating dataset_description.json can be error-prone and tedious. This script bridges the gap between raw data and BIDS organization, ensuring that essential introduction metadata is correctly formatted and located from the start.

Testing

  • Verified path generation logic for multiple directory structures.
  • Confirmed output JSON is readable by standard BIDS validators.

…equired for BIDS datasets, using a clean metadata template.

 This part of the code is used to create the correct path for the dataset_description.json file inside a BIDS project. By combining the main dataset directory (root_dir) with the project’s folder name (project_label), the code helps the program know exactly where this important file should be stored. In the BIDS structure, this file acts like an introduction to the dataset, so setting its path properly ensures the project stays organized and follows the standard format.
Python script that auto-generates the dataset_description.json file required for BIDS datasets, using a clean metadata template.
@sejalpunwatkar

Copy link
Copy Markdown
Author

Just checking in to see if there are any thoughts on this automation script or if any adjustments are needed to meet the BIDS utility standards. Please take a look whenever you have a moment!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant