<commit_before>OSURatchetMeter
===============

The OSU Ratchet Meter is a measurer of the 'ratchet' levels of Ohio State students throughout the semester.

Analysis is done through Twitter searches via the Twitter API. First, a list of Ohio State students is compiled by finding recent mentions of particular keywords and account mentions mostly used exclusively by Ohio State students. Then, a search for specific 'ratchet' keywords is done over the students' tweets over a specific semester. The number of occurences of these keywords per weekend are recorded, and a ratchet level is assigned to each weekend throughout the semester, along with a score for the semester as a whole.

## Team Members
- <NAME>
    + The Ohio State University
    + Graduating 2017
    + Computer Science & Engineering
    + http://www.kevinpayravi.com/
- <NAME>
    + The Ohio State University
    + Graduating 2017
    + Computer Science & Engineering
- <NAME>
    + The Ohio State University
    + Graduating 2017
    + Computer Science & Engineering

##Keywords and Mentions to Identify Students
Twitter's search API is limited to tweets from the last week. In order to compile a list of students, any users mentioning one of the following OSU-related accounts or hashtags is assumed to be an OSU student.

`#newtoOSU` `#osu18` `@OhioUnion` `@OUAB` `@OSUCrush`

##JSON Objects & Parameters

###List of JSON Arrays:
* `sp13`: Array of Week Statistics Objects for Spring 2013.
* `au13`: Array of Week Statistics Objects for Autumn 2013.
* `sp14`: Array of Week Statistics Objects for Spring 2014.
* `statistics`: Array of Semester Statistics Objects for each semester. 

###Week Statistics Object Parameters
Each of the sixteen objects list the week number, calculated ratchet level, and the number of occurances of keywords.
* `weekNumberCount`: Number of the week in the semester (`1` - `16`).
* `ratchetLevel`: Level of ratchetness during the weekend.
* `turnupCount`: Number of occurrences during weekend.
* `turntCount`: Number of occurrences during weekend.
* `turntttCount`: Number of occurrences during weekend.
* `ratchetCount`: Number of occurrences during weekend.
* `drunkCount`: Number of occurrences during weekend.
* `crunkCount`: Number of occurrences during weekend.
* `wastedCount`: Number of occurrences during weekend.
* `blackout_drunkCount`: Number of occurrences during weekend.
* `blacked_outCount`: Number of occurrences during weekend.
* `alcoholCount`: Number of occurrences during weekend.
* `boozeCount`: Number of occurrences during weekend.
* `beerCount`: Number of occurrences during weekend.
* `smashedCount`: Number of occurrences during weekend.
* `drunkatOSUCount`: Number of occurrences during weekend.
* `partyCount`: Number of occurrences during weekend.
* `partyingCount`: Number of occurrences during weekend.
* `partiedCount`: Number of occurrences during weekend.
* `tgifCount`: Number of occurrences during weekend.<commit_msg>Adding keywords section<commit_after>OSURatchetMeter
===============

The OSU Ratchet Meter is a measurer of the 'ratchet' levels of Ohio State students throughout the semester.

Analysis is done through Twitter searches via the Twitter API. First, a list of Ohio State students is compiled by finding recent mentions of particular keywords and account mentions mostly used exclusively by Ohio State students. Then, a search for specific 'ratchet' keywords is done over the students' tweets over a specific semester. The number of occurences of these keywords per weekend are recorded, and a ratchet level is assigned to each weekend throughout the semester, along with a score for the semester as a whole.

## Team Members
- <NAME>
    + The Ohio State University
    + Graduating 2017
    + Computer Science & Engineering
    + http://www.kevinpayravi.com/
- <NAME>
    + The Ohio State University
    + Graduating 2017
    + Computer Science & Engineering
- <NAME>
    + The Ohio State University
    + Graduating 2017
    + Computer Science & Engineering

## Identifying Students: Keywords and Mentions
Twitter's search API is limited to tweets from the last week. In order to compile a list of students, any users mentioning one of the following OSU-related accounts or hashtags is assumed to be an OSU student.

`#newtoOSU` `#osu18` `@OhioUnion` `@OUAB` `@OSUCrush`

## Getting Ratchet Levels: Keywords
`turnup` `turnt` `turnttt` `ratchet` `drunk` `crunk` `wasted` `blackout drunk` `blacked out` `alcohol` `booze` `beer` `smashed` `drunkatOSU` `party` `partying` `partying` `partied` `tgif` `puke` `puked` `puking` `drunk text` `drunk texting` `laid` `yolo` 

##JSON Objects & Parameters

###List of JSON Arrays:
* `sp13`: Array of Week Statistics Objects for Spring 2013.
* `au13`: Array of Week Statistics Objects for Autumn 2013.
* `sp14`: Array of Week Statistics Objects for Spring 2014.
* `statistics`: Array of Semester Statistics Objects for each semester. 

###Week Statistics Object Parameters
Each of the sixteen objects list the week number, calculated ratchet level, and the number of occurances of keywords.
* `weekNumberCount`: Number of the week in the semester (`1` - `16`).
* `ratchetLevel`: Level of ratchetness during the weekend.
* `turnupCount`: Number of occurrences during weekend.
* `turntCount`: Number of occurrences during weekend.
* `turntttCount`: Number of occurrences during weekend.
* `ratchetCount`: Number of occurrences during weekend.
* `drunkCount`: Number of occurrences during weekend.
* `crunkCount`: Number of occurrences during weekend.
* `wastedCount`: Number of occurrences during weekend.
* `blackout_drunkCount`: Number of occurrences during weekend.
* `blacked_outCount`: Number of occurrences during weekend.
* `alcoholCount`: Number of occurrences during weekend.
* `boozeCount`: Number of occurrences during weekend.
* `beerCount`: Number of occurrences during weekend.
* `smashedCount`: Number of occurrences during weekend.
* `drunkatOSUCount`: Number of occurrences during weekend.
* `partyCount`: Number of occurrences during weekend.
* `partyingCount`: Number of occurrences during weekend.
* `partiedCount`: Number of occurrences during weekend.
* `tgifCount`: Number of occurrences during weekend.
{'fraction_non_alphanumeric': 0.08106803924722535, 'fraction_numerical': 0.011259449895447965, 'mean_word_length': 4.854990583804143, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, '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': '278370', 'n_tokens_mistral': 1817, 'n_tokens_neox': 1574, 'n_words': 788}