tee-ar-ex / tee-ar-ex/trx-python
Extra header files for non-compulsory data
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 26
- Forks
- 20
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 9
Description
The current proposed structure contains file header.yaml alongside compulsory files offsets.uint64 and positions.3.float16.
Whenever additional data are generated and added to the dataset (e.g. let's use the mean FA along each streamline: dps/mean_fa.float32). One may wish to store additional information related to how that image was generated, what FA image was used, etc.. I think that in such cases, optionally storing an additional file dps/mean_fa.yaml makes most sense, i.e.. changing the file extension only, as is done with JSON files in BIDS. It's worth having this explained and demonstrated in the specification.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the specification section describing header.yaml, offsets.uint64, and positions.3.float16, then read how optional dataset data such as dps/mean_fa.float32 is documented. Explain and demonstrate the matching dps/mean_fa.yaml convention for metadata, including that it uses the same basename and changed extension.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- yaml
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100