4 ms·
Hi, I’m a Research Software Engineer (a person who makes software that helps academics/researchers) at a university in the UK. My recommendation is that not onl
by grahamlee 5y ago
Hi, I’m a Research Software Engineer (a person who makes software that helps academics/researchers) at a university in the UK. My recommendation is that not only do you publish the code, you mint a DOI (digital object identifier, Zenodo is usually the go to place for that) for the specific version that was used in your paper and you associate them. And you include a citation file (GitHub supports them now: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files https://docs.github.com/en/repositories/managing-your-reposi...) in your software repo.
Benefits: people who want to reproduce your analysis can use exactly the right software, and people who want to build on your work can find the latest in your repo. Either know how to cite your work correctly.
In practice drive-by nitpicking over coding style is not that common, particularly in (some) science fields where the other coders are all other scientists who don’t have strong views on it. Nitpicks can be easily ignored anyway.
BTW should you choose to publish, the Turing Way has a section on software licenses written for researchers: https://the-turing-way.netlify.app/reproducible-research/licensing.html https://the-turing-way.netlify.app/reproducible-research/lic...
- Drup 5y agoI would encourage you not to use DOIs for software. They are not made for this, and have limitations which are not appropriate. Instead, use Software Heritage https://www.softwareheritage.org/ https://www.softwareheritage.org/ , it provides unique identifiers and actually understand repositories, versioning, history, etc. It also allows you to cite the software and even give proper, durable links to point to the code.
- Siira 5y agoWhy not just link to a specific commit hash? What more do they provide?
- NGRhodes 5y ago/me waves from Leeds Uni. Hello fellow RSE.
- dm319 5y agoFor a physician that writes pretty awful code, I like this comment.
- nkko 5y agoAnd I would suppose it will drive more citations. Which is a plus!