
[![Build Status](https://travis-ci.org/psobczyk/varclust.svg?branch=master)](https://travis-ci.org/psobczyk/varclust)   [![codecov](https://codecov.io/gh/psobczyk/varclust/branch/master/graph/badge.svg)](https://codecov.io/gh/psobczyk/varclust)

[<img src="http://www.ideal.rwth-aachen.de/wp-content/uploads/2013/08/banner1.png">](http://www.ideal.rwth-aachen.de/)

-------------

# README #

### What is this repository for? ###

Package **varclust**

* is **R** package for clustering quantitative variables
* provides estimation of number of clusters
* enables significant data dimension reduction

[Check out demo version!](https://psobczyk.shinyapps.io/varclust_online/)


### How do I get set up? ###

* Install **varclust** package using devtools package
```R
install_github("psobczyk/varclust")
```
* Download the package as an archive and install it manually from **R** console
* You might need to install package dependencies:
    * **parallel**
    * **doParallel**
    * **foreach**
    * **doRNG**
    * **RcppEigen**
    * **pesel**

* The **pesel** package can be installed using devtools package
```R
install_github("psobczyk/pesel")
```

* No additional configuration is needed
* Read [vignette](https://psobczyk.shinyapps.io/varclust_online/varclustTutorial.html) to get familiar with basic usage

### Who do I talk to? ###
* If help provided in the package documentation does not solve your problem
please contact Piotr.Sobczyk[at]pwr.edu.pl

-------------
![alt tag](http://www.ideal.rwth-aachen.de/wp-content/uploads/2014/03/EU_logo_flag_yellow_small-without-padding.png)

This project has received funding from the European Union’s
Seventh Framework Programme for research, technological
development and demonstration under grant agreement no 602552.
