Documenting R Packages: What is a good example? (Hons) [Open] | School of Engineering
Skip navigation School of Engineering ANU College of Engineering & Computer Science Search query Search ANU web, staff & maps Search current site content Search People Current students Intranet Login Menu Search query Search People Current students Intranet Login Search ANU web, staff & maps Search current site content menu Search site search Search School of Engineering Search query Search Related sites School of Cybernetics Software Innovation Institute Engineering Home About Study Research Engage News & events Current students Contact Staff Related sites ANU College of Engineering & Computer Science School of Computing School of Cybernetics Reimagine Cyber Institute ASD-ANU Co-Lab » Data61 Sol Invictus McKenzie Chair W3C You are here » Research » Student research projects » Documenting R Packages: What is a good example? (Hons) [Open] Documenting R Packages: What is a good example? (Hons) [Open] People Supervisor Dr Melina Vidoni Description 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. Requirements 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. Please, contact me via email with a detailed resume, and your comments (1 page only) on why you are interested in on this project. Anybody is welcome to apply. However, female candidates (or female-identifying) are especially encouraged to submit. Background Literature Z. Codabux, M. Vidoni and F. Fard, "Technical Debt in the Peer-Review Documentation of R Packages: a rOpenSci Case Study," in 2021 IEEE/ACM 18th International Conference on Mining Software Repositories (MSR), 2021 pp. 195-206. https://doi.ieeecomputersociety.org/10.1109/MSR525... M. Vidoni, "Self-Admitted Technical Debt in R Packages: An Exploratory Study," in 2021 IEEE/ACM 18th International Conference on Mining Software Repositories (MSR), 2021 pp. 179-189. https://doi.ieeecomputersociety.org/10.1109/MSR525... Please, take a look at Dr Vidoni's papers here: https://melvidoni.rbind.io/project/2020-rse/ Keywords Empirical Software Engineering. Mixed-Methods. Developers Survey. Natural Language Processing Data Scienc Software, Scientific Software Developers' Challenges Updated: 10 August 2021/Responsible Officer: Head of School/Page Contact: CECS Marketing Contact ANU Copyright Disclaimer Privacy Freedom of Information +61 2 6125 5111 The Australian National University, Canberra CRICOS Provider : 00120C ABN : 52 234 063 906 You appear to be using Internet Explorer 7, or have compatibility view turned on. Your browser is not supported by ANU web styles. » Learn how to fix this » Ignore this warning in future
