Welcome to the wiki page!

In this page, I will give a tutorial about the use of the Chordalysis software.

Here is the step-by-step procedure that I'll develop.

1. Download

The download part is pretty easy, just download the .zip here:

2. Extraction

Not the hardest step either: just extract the zip where you want to (:

3. Get a dataset

Chordalysis analyses data, so... you need a dataset.

The requirements for the file containing the dataset are:

• it has to be a CSV file (openable by Weka)
• it has to be discrete (no numerical variables); if some (or all) are, you need to discretize your dataset first (using equal frequency for instance)
• there should be more than one value expressed for every variable: for example, if one of your variables is gender, then you cannot have females only (as it would be the case for a study about pregnant women). This is due to the fact that a variable with one value would just be correlated to everything, which wouldn't be a useful information. If you have such variables, just delete the corresponding column in the dataset.

You can have a look at the mushroom dataset for an example of correctly formatted CSV.

4. Launch the software on the dataset

Open a Windows/Linux/MacOS terminal and navigate to the repository in which you extracted Chordalysis.jar (cd command). Then if you simply type:

java -jar Chordalysis.jar

the terminal will tell you how to use the program:


petitjean@xx:~$ java -jar Chordalysis.jar
Usage: java -Xmx1g -jar Chordalysis.jar dataFile pvalue imageOutputFile useGUI?
Example: java -Xmx1g -jar Chordalysis.jar dataset.csv 0.05 graph.png false

Note: '1g' means that you authorize 1GB of memory.
Note: It should be adjusted depending upon the size of your data set (mostly required to load the data set).


So, if you saved the file

mushroom.csv

Chordalysis.jar


java -Xmx1g -jar Chordalysis.jar mushroom.csv 0.05 mush-graph.png false


5. Analyse the results