Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

User oriented documentation? #122

Open
yarikoptic opened this issue Feb 12, 2024 · 0 comments
Open

User oriented documentation? #122

yarikoptic opened this issue Feb 12, 2024 · 0 comments

Comments

@yarikoptic
Copy link

Is your feature request related to an existing module?

I was referred to the project but have difficulty figuring out what it would provide me with and in particular on either I could use some helper utilities/functionality to accomplish

  • offset all acq_time in all _scans.tsv files to anonymize
  • rename some bids files "correctly" (e.g. reflecting changes in _scans.tsv files)

Describe the solution you'd like

Documentation which shows some screenshots (if I get it right there is some WebUI) and may be sphinx documentation for the python library, with some code samples.

Feel free to separate into a separate issue , but since I do not know if it might already be there somehow. I was looking for some CLI eeg2bids which would expose a set of commands from what it has implemented, e.g.

  • eeg2bids offset-time [--units hours,days,weeks,years] [--bids-dataset PATH] N (I am thinking about weeks as to make it preserve day of the week, or may be in some cases "years" would be sufficient)
  • eeg2bids rename PATH-FROM PATH-TO (e.g. eeg2bids rename sub-01_T1w.nii.gz) or may be even eeg2bids change-entity --entity NAME --from VALUE --to VALUE PATHs (eeg2bids change-entity --entity sub --from 102923 --to 01 sub-102923) which in both cases would need all needed , e.g. adjust _scans.tsv and participants.tsv in the latter
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

No branches or pull requests

1 participant