phys2bids icon indicating copy to clipboard operation
phys2bids copied to clipboard

Document similar software

Open tsalo opened this issue 4 years ago • 5 comments

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 https://github.com/nipy/heudiconv/pull/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!

tsalo avatar Jun 17 '20 14:06 tsalo

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

smoia avatar Jun 17 '20 23:06 smoia

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.

tsalo avatar Jun 18 '20 15:06 tsalo

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

smoia avatar Jun 18 '20 15:06 smoia

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.

pvelasco avatar Jul 02 '20 19:07 pvelasco

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".

tsalo avatar Jul 02 '20 19:07 tsalo