Main content

Home

Menu

Loading wiki pages...

View
Wiki Version:
In software engineering, there is a common saying that “code is read by humans more than it is executed by computers’’. Whether this is exactly true or not, one message remains: readability counts. This is even more so in research, as code is often the only available detailed description of the computational experiments of data analyses underlying your research. In this lecture we cover simple techniques to make your codes easier to read - by yourself, your colleagues or your peers reproducing your research. We start by introducing the concept of a”code smell", a way to identify situations where code is difficult to understand and modify. Walking through a few examples, we describe well-defined remedies you can start applying right-away, such as simplifying complex conditionals or splitting long functions. Ressources and references for further reading are accessible from the following GitLab repository. https://framagit.org/tlestang/practical_approaches_sustainable_software
OSF does not support the use of Internet Explorer. For optimal performance, please switch to another browser.
Accept
This website relies on cookies to help provide a better user experience. By clicking Accept or continuing to use the site, you agree. For more information, see our Privacy Policy and information on cookie use.
Accept
×

Start managing your projects on the OSF today.

Free and easy to use, the Open Science Framework supports the entire research lifecycle: planning, execution, reporting, archiving, and discovery.