<commit_before>brita
=====

** Module is still in development - do not use ... YET!**

[![Build Status](https://travis-ci.org/JonathanPrince/brita.svg?branch=master)](https://travis-ci.org/JonathanPrince/brita)

[![NPM](https://nodei.co/npm/brita.png?downloads=true)](https://nodei.co/npm/brita/)

Object Filter Module for nodejs



<commit_msg>update readme to explain usage<commit_after>#brita
=====

** Module is still in development - do not use ... YET!**

[![Build Status](https://travis-ci.org/JonathanPrince/brita.svg?branch=master)](https://travis-ci.org/JonathanPrince/brita)

[![NPM](https://nodei.co/npm/brita.png?downloads=true)](https://nodei.co/npm/brita/)

##Description
====
Object Filter Module for nodejs

##Usage
====
Install the brita module using npm
```
$ npm install brita
```
Example
```
// require brita module
var brita = require('brita');

// object to be filtered
var myObject = {
    key1: 1,
    key2: 2,
    key3: 3,
    key4: 4
};

// filter function 
var myFilter = function(value){
    
    // return true for values less than 3
    if (value < 3) {    
        return true;
    } else {
        return false;
    }
};

// apply filter to create new object filtered by brita
var filteredObject = brita(myObject, myFilter);

```

{'fraction_non_alphanumeric': 0.16547901821060965, 'fraction_numerical': 0.00791765637371338, 'mean_word_length': 3.5142857142857142, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 3, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3032642', 'n_tokens_mistral': 460, 'n_tokens_neox': 433, 'n_words': 105}