README.md

In Dasonk/packageAnalyzeR: Analyzes the source code for R packages

packageAnalyzeR

This package was developed to facilitate data collection for the Stat 503 (Data Mining) final project. The goal is to make it easy to download the source code of a package from CRAN and create various statistics for the package. Once enough data is collected we can use the collected data to try to cluster the packages to see which packages are written in a similar manner.

Some examples of statistics that will eventually be supported:

• Number of .R files
• Average number of lines in each .R file
• Total number of lines over all .R files
• Spaces or tabs for indentations (probably won't make it in)
• Number of spaces per indentation level (probably won't make it in)
• Proportion of function names using camelCase
• Proportion of function names using under_scores
• Average number of definition (functions, environments, ...) per .R file
• Proportion of functions that are exported
• Number of other language source files used (C, C++, Fortran, Perl, ...)
• Average number of examples per exported function
• Average number of parameters per function
• Maximum number of parameters per function
• Does it use roxygen?
• Average length of help files
• Total length of test files
• License used
• Version format (major.minor, major.minor.tiny, major.minor-tiny)
• Number of Depends
• Number of Imports
• Number of Suggests
• Function definitions on a single line?

Installation

Currently there isn't a release on CRAN.

You can, however, download the zip ball or tar ball, decompress and run R CMD INSTALL on it, or use the devtools package to install the development version:

## Make sure your current packages are up to date
update.packages()
## devtools is required
library(devtools)
install_github("packageAnalyzeR", "Dasonk")

Note: Windows users need Rtools and devtools to install this way.

Help

For help you can figure it out yourself. Eventually there will be help support but not yet. Deal with it.

Dasonk/packageAnalyzeR documentation built on May 6, 2019, 1:38 p.m.