README.md 1.16 KB
Newer Older
David Chazalviel's avatar
David Chazalviel committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# scatterPlotMatrix

![scatterPlotMatrix snapshot](./doc/snapshots/SPM.png)

`scatterPlotMatrix` is an R package providing an interactive scatter plot matrix, written in R and javascript and based on [d3.js](https://d3js.org/).


## Context

This `scatterPlotMatrix` R package was initially developped as part of the [Lagun](https://gitlab.com/drti/lagun) project conducted by Safran Tech and IFPEN, to improve speed and responsiveness of its existing scatter plot matrix (more information [here](./doc/spm-features.md)). 


## Install

- Requirements: R (>= 3.5.1) available from [CRAN](https://cran.r-project.org/), git
17
- Clone the current repository: `git clone https://ifpen.gitlabfr.com/detocs/scatterplotmatrix.git`
David Chazalviel's avatar
David Chazalviel committed
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
- Install scatterPlotMatrix: `R -e "install.packages('scatterplotmatrix/htmlwidget/spm/', repos = NULL, type = 'source')"`

To generate `htmlwidget` files from source files, use gulp as follows:

``` sh
cd scatterplotmatrix
npm install
gulp buildScatterPlotMatrix
```

See [doc/devGuide.md](./doc/devGuide.md) for more information.

## List of contributors

- David Chazalviel (TECH'advantage, funded by IFPen)
- Benoit Lehman (TECH'advantage, funded by IFPen)