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

Document similar software #251

Open
tsalo opened this issue Jun 17, 2020 · 5 comments
Open

Document similar software #251

tsalo opened this issue Jun 17, 2020 · 5 comments
Labels
Community This issue is about the community, not the code Documentation This issue or PR is about the documentation

Comments

@tsalo
Copy link
Member

tsalo commented Jun 17, 2020

Detailed Description

There is currently a link to tarrlab/physio2bids in the README, but there are a few other tools that I think should be documented and compared to phys2bids explicitly.

Context / Motivation

In nipy/heudiconv#446, they are integrating one such tool (cbinyu/bidsphysio) into heudiconv. This tool serves a different niche (CMRR sequence-stored physio data), but is clearly related in function to phys2bids. It would be nice if all of the relevant tools linked to one another in their documentation, so that users are able to find the appropriate tool for their data easier.

Possible Implementation

Search for other software for converting physio data to BIDS format, and add links in either the README or the docs. Here is a partial list:

Plus, if any of these projects go stale, phys2bids devs could contact the creators to see if they'd be cool with merging their code into phys2bids!

@smoia
Copy link
Member

smoia commented Jun 17, 2020

Cool @tsalo, thank you for looking around!
Do you want to create a documentation page or section?

@smoia smoia added Community This issue is about the community, not the code Documentation This issue or PR is about the documentation labels Jun 17, 2020
@tsalo
Copy link
Member Author

tsalo commented Jun 18, 2020

It doesn't look like there's a good page in the docs for it, and I don't think it's big enough for a page of its own, so I think a section relatively low on the main docs page is the best option.

@smoia
Copy link
Member

smoia commented Jun 18, 2020

@tsalo you can also expand this page to contain more sections - not only measurement but also analysis.

@pvelasco
Copy link

pvelasco commented Jul 2, 2020

In nipy/heudiconv#446, they are integrating one such tool (cbinyu/bidsphysio) into heudiconv. This tool serves a different niche (CMRR sequence-stored physio data),

Clarification: cbinyu/bidsphysio started with CMRR physio data stored in the DICOM files, but now it also handles AcqKnowledge and PMU files. We are working on EyeLink files too, and on automating the BIDS file-naming by using @tsalo's conversion.py module.

@tsalo
Copy link
Member Author

tsalo commented Jul 2, 2020

Ah yes sorry about that @pvelasco. When I found out that bidsphysio had a larger scope than I originally thought, I updated the list under "Possible Implementation" but forgot to update the paragraph in "Context / Motivation".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Community This issue is about the community, not the code Documentation This issue or PR is about the documentation
Projects
None yet
Development

No branches or pull requests

3 participants