Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DennisSchwartz/mplexviz-ngraph
A BioJS visualisation component for the mplexnet Multilayer Network model using ngraph
https://github.com/DennisSchwartz/mplexviz-ngraph
Last synced: about 1 month ago
JSON representation
A BioJS visualisation component for the mplexnet Multilayer Network model using ngraph
- Host: GitHub
- URL: https://github.com/DennisSchwartz/mplexviz-ngraph
- Owner: DennisSchwartz
- License: mit
- Created: 2015-10-09T16:39:09.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-11-15T19:57:03.000Z (about 6 years ago)
- Last Synced: 2024-04-29T13:21:04.315Z (8 months ago)
- Language: HTML
- Size: 1.3 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - DennisSchwartz/mplexviz-ngraph - A BioJS visualisation component for the mplexnet Multilayer Network model using ngraph (others)
README
# mplexviz-ngraph
[](https://www.npmjs.org/package/mplexviz-ngraph)
> A visualisation module for multilayer networks as modelled by [mplexnet](https://github.com/DennisSchwartz/mplexnet)
using [ngraph.three](https://github.com/anvaka/ngraph.three).
## Getting Started
This is a visualisation module for multilayer network data.
#### Beware:
This project is still under active development and should only be used experimentally for now. Expect a more mature
version in the next few months. If you have suggestions and feature requests, feel free to contact me.
You can install the module with: `npm install mplexviz-ngraph`
To test it, try something like this:
```javascript
var Viz = require('mplexviz-ngraph');
var data = 'source,l1,l2,target,l1,l2\n1,A,X,2,A,X\n1,A,X,1,B,X\n1,A,X,4,B,X\n1,B,X,1,B,Y\n1,B,X,3,B,X\n\
1,B,X,4,B,X\n3,B,X,4,B,X\n4,B,X,3,A,Y\n3,A,Y,3,A,X\n3,A,Y,2,A,Y';
var instance = new Viz({
el: rootDiv,
data: data
});
instance.render();
```
## Specifying options
You can specify some options for the mplexnet module. It is mostly setting options for the data input.
```javascript
/*
* These are the default options for a network
*
* Log levels:
* 1: Errors and important info
* 2: More info
* 3: Detail debug messages incl. data
*/
var options = {
inputFiles: 'csv',
inputFileDelimiter: ',',
sourceFieldLabel: 'source',
targetFieldLabel: 'target',
loglevel: 0
};
var instance = new Viz({
el: rootDiv,
data: data,
options: options
});
instance.render();
```
## Input format
There will be more detailed description of the input format soon. This maybe subject to change
For now, there are two possible ways to pass data:
* A single csv data object of edges between node-layer objects (recommended)
```
source,l1,l2,target,l1,l2
1,A,X,2,A,X
1,A,X,1,B,X
1,A,X,4,B,X
1,B,X,1,B,Y
1,B,X,3,B,X
1,B,X,4,B,X
3,B,X,4,B,X
4,B,X,3,A,Y
3,A,Y,3,A,X
3,A,Y,2,A,Y
```
* Three separate files/objects
* A list of aspects
```
Time
```
* A list of node-layer objects with a unique id
```
id,Time,name
1,now,1
2,now,2
3,now,3
4,now,4
5,then,1
6,then,2
7,then,3
8,then,4
```
* A list of edges between these ids
```
source, target
1, 4
2, 3
2, 4
1, 5
2, 6
3, 8
4, 8
5, 6
5, 7
6, 7
```
## Contributing
I have a set of features I want to complete for now. When done, all contributions will be welcome.
## Support
If you have any problem or suggestion please open an issue [here](https://github.com/DennisSchwartz/mplexviz-ngraph/issues).
## License
The MIT License
Copyright (c) 2015, Dennis Schwartz
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.