-
Notifications
You must be signed in to change notification settings - Fork 10
Home
Some documentation related to vizGrimoireR. Work in progress!
This wiki is also been used for the moment to document the whole *Grimoire collection.
Before installing the vizgrimoire R library, some R libraries are needed:
- RMySQL (for building this, you'll need MySQL client development files, such as those provided by the Debian/Ubuntu package libmysqlclient-dev)
- rjson
- RColorBrewer
- ggplot2
- rgl (for building this, you'll need X11 client-side development files, such as those provided by the Debian/Ubuntu package libx11-dev, and some OpenGL development files, such as those provided by the Debian/Ubuntu packages mesa-common-dev and libglu1-mesa-dev)
- optparse
- zoo
Each of them can be installed from the R prompt, from CRAN archives, by typing:
install.packages("libraryname")
In addition, the misc/install_dependencies.R R script could also be used: it installs all these dependencies (see below).
Once all these dependencies are installed, the vizgrimore R package can be installed:
- From the parent directory of vizgrimoire:
% R CMD INSTALL vizgrimoire
- Or locally:
% R CMD INSTALL -l vizgrimoire % R_LIBS=:$R_LIBS R --vanilla ....
- Or, to produce a tarball, from the vizgrimoire directory (which will be later installed):
% R CMD build # To build the package tarball % R CMD check # To check the package tarball
Description of utilities found in /misc
- metricsgrimoire-setup.py: Simple Python script to set up some MetricsGrimoire tools from their GitHub repositories, ready to work with vizGrimoireR. It just clones the GitHub repositories for the relevant MetricsGrimoire tools (currently CVSAnalY, Bicho, MLStats) and their dependencies (currently RepositoryHandler) in the specified directory. Run with option --help for a description and list of options. Once the script finishes, it shows how to set up the environment so that the tools can be used.
- install_dependencies.R: Simple R script which installs all the required R libraries for the vizgrimoire R package to work. See comments in that file for some system libraries and development files that should be installed in order to some of those libraries to be compilable.
In the directory examples there are examples of how to use vizGrimoireR (and in some cases, vizGrimoireJS) for analyzing some specific projects:
The whole *Grimoire collection (MetricsGrimoire, vizGrimoire) needs some love to be installed properly. Find below detailed examples of how to do that in some specific environments