Assignment 04: Text Analysis
CS101 - Intro To Computer Science

Fall 2023

In this assignment, you will implement a text analysis tool that counts the number of verbal ticks.

In contrast to previous assignments, you must implement certain tasks using different methods.

Prerequisites:

• Methods

• Arrays

The files for this assignment are in a zip file called 04_text_analysis.zip. There are four groups of files files in the folder

• TextAnalysis.java: the base implementation of the assignment - includes comments with the functions you need to implement.

• TextAnalysisTest.java: unit tests - make sure you pass these unit tests before submitting the assignment.

• .jar files in the lib folder: libraries to enable the use of the unit tests.

• trump_speech_010621.txt: An example text file to run your main function on.

1. Project Setup

2. Text Analysis

"uh", "um", etc) the program must ask the user what tics to look for. A user can enter multiple tics, separated by commas. Any spaces entered by the user before or after each tic must be ignored. You can assume that all tics are single words.

We will do this task by implementing a variety of small methods to accomplish this larger task. Every method you need to implement is described in TextAnalysis.java. Not every method has a function prototype prepared - some functions like the countOccurrences method is only described in a comment so you get to define the method’s prototype (i.e specify the parameters and return value of the method). The @param and @return statements in the comments indicate what the expected parameters and return type should be. If you correctly implement these methods your code should "pass" the unit tests in src/edu/nyu/assignment4/tests/TextAnalysisTest.java.

A description of how to check if your code passes unit tests is later in the document. After the program is fully implemented, it should output allow the user to submit a text file and a sequence of tics separated by commas and it should return the following statistics:

• the total number of tics found in the text

• the density of tics (proportion of all words in the text that are tics)

• the frequency of each of the verbal tics

• the percentage that each tic represents out of all the total number of tics

3. Unit Tests

This assignment includes unit tests to make sure that your code conforms to our expected set of methods. Unit tests are used for a variety of reasons, but two key reasons are what we are doing here, to define how code should be invoked, and also to make sure that code continues to perform consistently over time.

The unit tests will only build and run AFTER you have defined the various methods required for this assignment. Unit tests can be run by following the instructions in Figure 1. Note that these unit tests are VERY similar to how your assignments are graded - the autograder we use is implemented by running similar unit tests and giving marks if you pass them.