Package development process: Difference between revisions

Revision as of 02:43, 11 September 2010

Revision as of 01:29, 12 September 2010

Line 13:

For example, a [[Python (programming language)|Python]] package combines documentation, code and initial set up and possibly examples that could be used as [[unit testing|unit tests]] in a single file with a "py" extension.

By contrast, an [[R (programming language)|R]] package has documentation with examples in files separate from the code, possibly bundled with other material such as sample data sets and introductory ''vignettes''. The source code for an R package is contained in a directory with a master "DESCRIPTIONdescription" file and separate subdirectories "man" containingfor documentation files, "R"code, with filesoptional ofdata codesets suits for unit or regression testing, and perhaps others. <ref> {{cite book|title=Writing R Extensions |authorlink=<!-- R Development Core Team --> |url =http://cran.r-project.org/doc/manuals/R-exts.html | }} </ref> A formal package compilation process

<ref> {{cite article

| last = Leisch | first = Friedrich

Line 23:

| title = Creating R Packages, Using CRAN, R-Forge, And Local R Archive Networks And Subversion (SVN) Repositories

| url =http://cran.r-project.org/doc/contrib/Graves+DoraiRaj-RPackageDevelopment.pdf| }}

</ref> checks for errors of various types. This includes checking for syntax errors on both the documentation markup language and the code as well as comparing the arguments between documentation and code. Examples in the documentation are tested and produce error messages if they fail. This can be used as a primitive form of [[unit testing]]; more formal unit tests and [[regression testing]] can be included in a "tests" subdirectory. This can improve software development productivity by making it easier to find bugs as the code is being developed. In addition, the documentation makes it easier to share code with others. It also makes it easier for a developer to use code written months or even years earlier. PackagesRoutine checks are made of packages contributed to the R software repository CRAN (the Comprehensive R Archive Network) <ref> {{ cite web

| title=The Comprehensive R Archive Network | url =http://cran.r-project.org}} </ref> and under development in thecompanion [[Apacheopen-source Subversion|Subversion]]collaborative development web repositorysite, R-Forge <ref> {{ cite web | title = R-Forge | url=http://r-forge.r-project.org}} </ref>. are repeatedlyThese compiledchecks compile the packages repeatedly on different platforms under different versions of the core R language. The results are made available to package maintainers. In this way, package contributors become aware of problems they might otherwise never encounter themselves, because they otherwise would not have easy access to those alternative test results.

An interesting research question would be to compare the quality of contributions to different [[software repository | software repositories]] and try to relate that to features of the package development process, i.e., the degree of formality and enforcement of standards for documentation, code, and testing and to the rate of growth of usage of contributed software.

==See also==