Update README with extension details and NIfTI filter

[CMonnin]

Clarified file extension description and added example filter for NIfTI files.

Summary by CodeRabbit

• Documentation
  • Clarified extension field specification format (no leading dot; e.g., nii.gz, json).
  • Added example demonstrating how to filter CSV data for NIfTI files.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Documentation updates to README.md clarifying the extension field format for libBIDSsh_parse_bids_to_csv, specifying that extension values have no leading dot (e.g., nii.gz, json), and adding an example demonstrating NIfTI file filtering.

Changes

Cohort / File(s)	Summary
Documentation README.md	Clarified extension field format documentation (no leading dot); added example for filtering CSV data by NIfTI extension; minor end-of-file formatting adjustment

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Documentation-only changes with no functional code impact
• Single file modification
• Clear, straightforward clarifications and example addition

Poem

🐰 A dot was shed from the extension's head,
Now nii.gz shines without dread!
New examples bloom in the README's room,
Filtering files—no more gloom! 📚✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main changes: updating README documentation with extension details and adding a NIfTI filter example.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 29c9e5f and cd3d988.

📒 Files selected for processing (1)

• README.md (3 hunks)

🔇 Additional comments (3)

README.md (3)

61-61: Documentation clarification is clear and helpful.

The update specifying "no leading dot" and providing concrete examples (nii.gz, json, etc.) improves usability by setting exact expectations for the extension field format.

---

89-90: New NIfTI example effectively demonstrates the clarified extension format.

The example is well-placed, follows the documentation update, and provides a practical use case that directly supports users applying the "no leading dot" format rule.

---

325-325: LGTM.

End-of-file formatting update. No functional changes to documentation content.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}