nipy / heudiconv

Flexible DICOM conversion into structured directory layouts
https://heudiconv.readthedocs.io
Other
234 stars 125 forks source link

[DOC] Lacking information about heudiconv commands populate-templates etc #696

Open askieslinger opened 1 year ago

askieslinger commented 1 year ago

Summary

Where can I find more information about the heudiconv commands mentioned here ?

--command | Possible choices: heuristics, heuristic-info, ls, populate-templates, sanitize-jsons, treat-jsons, populate-intended-for Custom action to be performed on provided files instead of regular operation. -- | --

Specific information about each workflow would help a lot to be able to understand and use the tool.

yarikoptic commented 1 year ago

yeah, we should improve API (make them proper sub-commands) and documentation on this. ATM it is just looking at the code and searching through docs to find more description and examples of use as e.g. for populate-templates: https://heudiconv.readthedocs.io/en/latest/search.html?q=populate-templates&check_keywords=yes&area=default would lead you to