search

PeerHerholz / BIDSonym

a BIDS app for pseudo-anonymization of neuroimaging data
https://peerherholz.github.io/BIDSonym/
BSD 3-Clause "New" or "Revised" License
51 stars 14 forks source link

improvements to installation documentation #54

Closed neuromusic closed 3 years ago

neuromusic commented 3 years ago

(related to JOSS Review at openjournals/joss-reviews#3169)

the installation instructions suggest docker pull peerherholz/bidsonym:version to install, however "version" is invalid. this should be updated to a command that can be copied and pasted, like docker pull peerherholz/bidsonym or docker pull peerherholz/bidsonym:latest

similarly, there's a typo in the markup for the code to pull from singularity at https://peerherholz.github.io/BIDSonym/installation.html#directly-pulling-from-singularity-hub

PeerHerholz commented 3 years ago

Ahoi hoi @neuromusic,

thanks a lot for the feedback. You're definitely right that only including docker pull peerherholz/bidsonym:version will lead to problems. However, to also prevent copy paste errors/problems via including only certain examples for specific versions (e.g. docker pull peerherholz/bidsonym:v0.0.4), I extended the respective part(s) of the documentation to include and explain both the place holder and the specific version option. Furthermore, the section related to Singularity was updated and markup related problems fixed.

Thanks again!