Nomadic People Migration
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    circular-migration-plotpublic

    Circular Migration Plot

    Creating interactive circular migration plots for the web using D3, like http://www.global-migration.info/ and http://www.german-migration.info/

    Installation

    Install globally with npm:

    npm install circular-migration-plot -g

    Usage

    1. Filtration (optional)

    You may want to filter countries with small migration flows:

    cmp-filter data/countries.csv data/flows.csv

    2. Compilation

    Build the matrix json processible by the library out of the csv input file.

    Usage

    cmp-compile file [OPTIONS]

    Available Options

    • --regions, -r: Sort order for regions
    • --pretty, -p: Pretty print result JSON

    Examples

    cmp-compile flows.csv
    cmp-compile -
    cat flows.csv | cmp-compile
    cmp-compile flows.csv --regions North,West
    cmp-compile flows.csv --regions North,West --pretty

    3. Integration

      <script src="dist/circular-migration-plot.js"></script> 
      <div id=timeline></div>
      <div id=chart></div>
      <script>
        CircularMigrationPlot({
          data: 'json/sample.json',
          chart: '#chart',
          timeline: '#timeline'
        });
      </script> 

    See index.html.

    Lets get dirty

    head -n30 data/flows.csv | cmp-filter data/countries.csv | cmp-compile > migration-flows.json

    Development

    Hint & Test

    To run the unit tests:

    npm test

    For JShint:

    npm run jshint
    

    Build

    The JavaScript is build using Browserify and then compressed with UglifyJS:

    npm run build
    

    Packagued files land in dist folder.

    Server

    A development server can be run with

    npm start
    

    License

    Copyright (c) 2014 null2 GmbH Berlin
    This work as well as the sample data is licensed under a Creative Commons Attribution-NonCommercial 3.0 Unported License.

    install

    npm i circular-migration-plot

    Downloadsweekly downloads

    8

    version

    1.2.0

    license

    MIT

    repository

    githubgithub

    last publish

    collaborators

    • avatar