检索结果-内蒙古大学图书馆

Towards a taxonomy of Roxygen documentation in R packages

EMPIRICAL SOFTWARE ENGINEERING 2023年第4期28卷 1-48页

作者： Vidoni, Melina Codabux, Zadia Australian Natl Univ CECC Sch Comp Canberra Australia Univ Saskatchewan Dept Comp Sci Saskatoon SK Canada

Software documentation is often neglected, impacting maintenance and reuse and leading to technical issues. In particular, when working with scientific software, such issues in the documentation pose a risk to producing reliable scientific results as they may cause improper or incorrect use of the software. R is a popular programming language for scientific software with a prolific package-based ecosystem, where users contribute packages (i.e., libraries). R packages are intended to be reused, and their users rely extensively on the available documentation. Thus, understanding what information developers provide in their packages' documentation (generally, through a system known as Roxygen, based on Javadoc) is essential to contribute to it. This study mined 379 GitHub repositories of R packages and analysed a sample to develop a taxonomy of natural language descriptions used in Roxygen documentation. This was done through hybrid card sorting, which included two experienced R developers. The resulting taxonomy covers parameters, returns, and descriptions, providing a baseline for further studies. Our taxonomy is the first of its kind for R. Based on previous studies in pure object-oriented languages, our taxonomy could be extensible to other dynamically-typed languages used in scientific programming.

关键词： R Programming package documentation Scientific software documentation taxonomy

来源：评论

学校读者我要写书评

暂无评论

Ibm :: 360 :: Programcatalog :: Gc20-1619-8 Catalog of Pgms

引用

2016年

[Auto Generated] 'CONTINUOUS SYSTEM MODELING PROGRIM (CSMP). CONTOURS OF CONSTANT RESPONSE fOR THE+ CONTROL (ACP). tPARS CONTROL (MCC-II) FOR 1401 COMPATIBILITY ON+ CONTROL - TRAFFIC SIGNAL OPTIMAL PROGRESSION+ CONTEOL APPLICATION PROGRAM (CCAP). CONTROL APPLICATION PROGRAM~ 'EROKEBIGE+ CONTROL CARD CONVERSION UTILITY PROGRAM. CONTROL CARD CONVERTER. 'DOS II TO DOS III CONTROL CARD EDIT & ANALYSIS. ITEST/360 CONTROL FLOWCHART PROGRAM S/369 DOS-TOS JOB CCNTROL GRAPHICS. nOMERICAL CONTROL MACROS F