search

datalad / datalad.org

Website sources of datalad.org
https://www.datalad.org
4 stars 10 forks source link

ENH+BF: added paragraph+asciinema for heudiconv #17

Closed yarikoptic closed 7 years ago

yarikoptic commented 7 years ago

I also copied a sample .cmds file for now but wasn't sure on the best way to incorporate it.

yarikoptic commented 7 years ago

ah silly me -- those .sh scripts aren't the "scripts" really -- they are "cast scripts"... will remove and force push in a second.

aqw commented 7 years ago

@yarikoptic I believe the command you want to use is:

tools/cast2script docs/casts/heudiconv_dicom_to_bids.sh

---Alex

aqw commented 7 years ago

@yarikoptic Don't worry about it. I'll merge this as is and clean it up. :-)

---Alex

yarikoptic commented 7 years ago

I already cleaned it up ;-)

aqw commented 7 years ago

@yarikoptic Pushed?

aqw commented 7 years ago

@yarikoptic Merged. I cleaned up some of the language and generated the heudiconv_dicom_to_bids.sh for you.

A few things: 1) I deleted heudiconv_dicom_to_bids.cmds because I didn't see the value in it. All the commands are listed in the .sh file, and the full timing is available in the asciicast. If you feel I have overreached, let me know and we can discuss. 2) Please take a look at the title "Automation and Control of Data Acquisition". It is long and I feel it poorly reflects the information covered in that section. It should be improved upon.

Thanks again for the PR. :-)

---Alex

yarikoptic commented 7 years ago

Here is how those .cmds getting their 2nd life: https://asciinema.org/a/134832 ;-)

Title: yeah, didn't like it either ;) thanks @aqw ;) may be straight to the point -- "BIDS DataLad Datasets" or better more specific "Automated Creation of BIDS DataLad Datasets"?

aqw commented 7 years ago

@yarikoptic You still havn't explained what tangible value those .cmd files provide that the .sh script and .json don't cover.

I see the .cmd files have command duration, but I can't come up with a real scenario where that is useful.

---Alex

aqw commented 7 years ago

@yarikoptic Ahh, if the point of that paragraph is to highlight the use of BIDS, that wasn't clear. It does meander a bit. Please confirm if that is indeed the case, and I can take a stab at rewriting it to be more direct.

---Alex

yarikoptic commented 7 years ago

@aqw re .cmd files -- to centralize the description I have expanded the third item in https://github.com/datalad/datalad.org/issues/23