Most programming languages have documentation systems derived from in-line comments. The most reknown of these are Java's Javadoc. Roxygen, is a system created for R programming in the likeliness of Javadoc, which has gained ubiquity in the R community after being championed by primer books and organisations such as rOpenSci and BioConductor.
In this project, you'll mine open-source GitHub packages, extract their Roxygen documentation, detect the sections related to the examples, and perform a number of automated (e.g., length, location, bugs, dependency on external dataseets, does it run?) and manual (is it commented? explained?). You will accompany this with an anonymous, online survey of R developers (you'll need to apply for an Ethical Application, but will be assisted to do so).
Note: This project is open and recruiting students.
- Programming knowledge, preferably either Python or R. Other languages are welcome but not needed.
- Knowledge (or willingness to learn quickly) about using APIs to download data.
- Demonstrated academic writing skills.
- Excellent attention to details.
- Empirical Software Engineering. Mixed-Methods. Developers Survey.
- Natural Language Processing
- Data Scienc Software, Scientific Software
- Developers' Challenges