<commit_before># svgHeatmap

This project aims to allow the aapplication of CSV data to a supplied
SVG image. The motivation is to ease the use and re-use of a given SVG
image to create a heatmap or cloropleth from changing/differing data
sets.

There are no external dependencies, which means this project can be used
offline. As well as making the project more portable, the hope is that
this makes it easier to trust the code.

## Installation

Simply clone or download this repository to your machine.

## Usage

Point your web-browser at the folder containing your copy of this
project (which should load index.htm).

From then on the minimal steps would be to use the appropriate buttons
to load the required SVG and CSV data files, and then clicking on the
save button at the bottom of the page to download the resulting image.

### SVG Creation

The only requirements of the SVG are that the regions which are required
to be programatically filled must have a unique id.

Creating an SVG file is beyond the scope of this project. I would
recommend [Inkscape](https://inkscape.org) for this job (although
virtually any program capable of producing SVGs will suffice).

In Inkscape the id of a closed path can be set from the "Object
Properties" panel (opened with Ctrl-Shift-O).

### CSV requirements

CSV files can be produced from virtually any spreadsheet program.
LibreOffice Calc, is one example. Microsoft Excel would also work, at a
pinch.

The CSV file must have rows consisting of  
\<region name\>, \<region value\>  
pairs. Provided the Region name matches (case-sensitive) exactly with an
id from the SVG the region value will be applied.

Empty rows and rows not in this format are ignored.

## Known Limitations

At the time of writing this, the project has only been successfully
tested on the Firefox web browser (v54.0.1). Edge is known not to work
and chrome/opera/any other you can think of is untested.
<commit_msg>Correcting README.md on matter of browser compatibility.<commit_after># svgHeatmap

This project aims to allow the aapplication of CSV data to a supplied
SVG image. The motivation is to ease the use and re-use of a given SVG
image to create a heatmap or cloropleth from changing/differing data
sets.

There are no external dependencies, which means this project can be used
offline. As well as making the project more portable, the hope is that
this makes it easier to trust the code.

## Installation

Simply clone or download this repository to your machine.

## Usage

Point your web-browser at the folder containing your copy of this
project (which should load index.htm).

From then on the minimal steps would be to use the appropriate buttons
to load the required SVG and CSV data files, and then clicking on the
save button at the bottom of the page to download the resulting image.

### SVG Creation

The only requirements of the SVG are that the regions which are required
to be programatically filled must have a unique id.

Creating an SVG file is beyond the scope of this project. I would
recommend [Inkscape](https://inkscape.org) for this job (although
virtually any program capable of producing SVGs will suffice).

In Inkscape the id of a closed path can be set from the "Object
Properties" panel (opened with Ctrl-Shift-O).

### CSV requirements

CSV files can be produced from virtually any spreadsheet program.
LibreOffice Calc, is one example. Microsoft Excel would also work, at a
pinch.

The CSV file must have rows consisting of  
\<region name\>, \<region value\>  
pairs. Provided the Region name matches (case-sensitive) exactly with an
id from the SVG the region value will be applied.

Empty rows and rows not in this format are ignored.

## Known Limitations

At the time of writing this, the project has been successfully tested on
the Firefox (v57) and Chrome (v62) web browsers. Edge is known not to
work (saving the resultant heatmap fails). Other browsers are untested.

{'fraction_non_alphanumeric': 0.041814495691839836, 'fraction_numerical': 0.0020273694880892043, 'mean_word_length': 4.1662303664921465, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2573546', 'n_tokens_mistral': 1053, 'n_tokens_neox': 1000, 'n_words': 638}