<commit_before>peoplenames.js
==============

a detailed JS object with methods for manipulating the names of people.

created 10/30/2013

PURPOSE

In some situations, you may be required to manipulate the names of people in a very detailed manner (e.g., family tree web app, etc.) and this object and accompanying methods are designed to be a utility for making those tasks easier.  

DOCUMENTATION 

The most up-to-date version of the documentation can be found in documentation.html which is included with the files.

EXAMPLE USAGE

dude = new Name("Edward","Montgomery","Proudfoot"); // create obj

initials = dude.getName("f-last"); // returns str with first initial and last name "<NAME>" 

reverse = dude.getName("last-first"); // returns str of name in reverse order "<NAME>"  

See the documentation for a complete list of methods and available format types.

FUTURE PLANS

I number of additional features (beyond name formatting) are planned, including:

- display name property for designating a default string value 
- suffix usage (e.g., "II" "Jr.")
- maiden names 
- nicknames
- intercalation (e.g., "van" "de" etc.)
- incomplete names (missing name components) 
- anonymous names (e.g., "living Smith" "[redacted] Smith")
- foreign lexical ordering (e.g., Eastern vs. Western ordering) 
- capitalization settings

LICENSE

PeopleNames.js is licensed under the MIT license.
<commit_msg>readme fix<commit_after>
PeopleNames.js 
==============

Documentation for PeopleNames.js a framework for formatting and manipulating the names of people.

created - 10/30/2013
last updated - 11/11/2013 

PURPOSE

In some situations, you may be required to manipulate the names of people in a very detailed manner (e.g., family tree web app, etc.) and this object and accompanying methods are designed to be a utility for making those tasks easier.  

DOCUMENTATION 

The most up-to-date version of the documentation can be found in documentation.html which is included with the files.

EXAMPLE USAGE

dude = new Name("Edward","Montgomery","Proudfoot"); // create obj

initials = dude.getName("f-last"); // returns str with first initial and last name "<NAME>" 

reverse = dude.getName("last-first"); // returns str of name in reverse order "<NAME>"  

See the documentation for a complete list of methods and available format types.

FUTURE PLANS

I number of additional features (beyond name formatting) are planned, including:

- display name property for designating a default string value 
- suffix usage (e.g., "II" "Jr.")
- maiden names 
- nicknames
- intercalation (e.g., "van" "de" etc.)
- incomplete names (missing name components) 
- anonymous names (e.g., "living Smith" "[redacted] Smith")
- foreign lexical ordering (e.g., Eastern vs. Western ordering) 
- capitalization settings

LICENSE

PeopleNames.js is licensed under the MIT license.

{'fraction_non_alphanumeric': 0.09355290819901892, 'fraction_numerical': 0.008409250175192713, 'mean_word_length': 4.153429602888087, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3534772', 'n_tokens_mistral': 808, 'n_tokens_neox': 755, 'n_words': 370}