User Guide

ProgrammerError (PE) is a desktop app for managing students’ information, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). Designed for CS2100 Lab Teaching Assistants (TAs), this application is optimized to track personal particulars, emails and lab results of your students across different classes. If you are familiar with Unix commands, this is definitely for you!

Table of Contents

• Glossary
• Quick Start
• Features
  1. Parameter Summary
  2. General Features
     1. View Help: help
     2. View Dashboard dashboard
     3. Exit: exit
  3. Data Features
     1. Fill Sample Data: fill
     2. Purge All Data: purge
     3. Upload Data: upload
     4. Download Data: download
     5. Edit The Data File Directly (For advanced users)
  4. Student Features
     1. Add Student: add
     2. Edit Student Details: edit
     3. Delete Student: delete
     4. Filter Students: filter
     5. Show Student Details: show
     6. List All Students: list
  5. Lab Features
     1. Add Lab: addlab
     2. Edit Lab: editlab
     3. Delete Lab: dellab
• Command Summary

Glossary

• Student ID: NUS student matriculation number (AXXXXXXXY)
• Email: NUS student email (eXXXXXXX@u.nus.edu)
• TA: CS2100 lab teaching assistant
• PE: ProgrammerError
• CSV: Comma-Separated Values

Quick Start

1. Ensure you have Java 11 or above installed in your Computer.
2. Download the latest programmerError.jar from here.
3. Copy the file to the folder you want to use as the home folder for your ProgrammerError.
4. Double-click the file to start the app. The GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
   

   

5. Type the command in the command box and press Enter to execute it. For example, typing help and pressing Enter will open the help window.
   Here are some example commands you can try:
   • add -n Sherwin -sid A1234567X -cid B01 -email e0523451@u.nus.edu: Adds a student named Sherwin to PE with his Student ID, Class ID and Email.
   • edit 1 -n Sherwin: Updates the name of the student at index 1 of the displayed list (1-indexed) to Sherwin.
   • delete 1: Deletes the student at index 1 of the displayed list (1-indexed).
   • filter -sid A1234567X: Filters the list of students to display the student(s) whose student ID contains A1234567X (case-insensitive).
6. Refer to the Features below for details on all available commands. Take note that command parameters wrapped with [ ] listed in this guide signifies that the parameter is optional.

Features

1. Parameter Summary

Note: Take note that all the commands that require the corresponding parameter follows the constraints as specified in the table below, apart from filter command.
filter command filters the list based on partial character sequence matching and hence does not have to follow the constraints strictly.

2. General Features

2.1 View Help: help or F2 on keyboard

Shows a message explaining how to access the help page.

2.2 View Dashboard: dashboard

Displays a dashboard window that updates dynamically showing the following data:

1. Number of students
2. Number of classes
3. Number of labs
4. Number of labs unmarked for each class

Below is an example of a dashboard window when the dashboard command is executed.

2.3 Exit: exit or F1 on keyboard

Exits ProgrammerError and closes the GUI.

3. Data Features

3.1 Fill Sample Data: fill

Fills the program with sample data if no data is already present. Otherwise, throws an error message.

Note: As this is a mass operation, it might take a couple of seconds to complete.

3.2 Purge all Data: purge

Clears all data in PE. This can be used to delete pre-existing sample data or existing student data. Otherwise, throws an error if no pre-existing data.

3.3 Upload Data: upload or F4 on keyboard

Uploads student data via a CSV file with the following header: studentId,classId,name,email. Note that the data should contain only the student ID, class ID, name and email field respectively and spaces directly before or after commas should be avoided.

Here is an example CSV file on GitHub. You may download files from GitHub following the instructions here.

In summary:

1. Select a valid CSV file (with header: studentId,classId,name,email) from the file chooser.
2. Note that this command is not meant for uploading lab results. Rather, it is only for automating the adding of students to PE.

3.4 Download Data: download or F3 on keyboard

Downloads the student data to a CSV file in the chosen directory. The file will be automatically named programmerError.csv.

3.5 Edit The Data File Directly (For advanced users)

Instead of using commands to edit students’ details and lab results, you may change the json file directly.

Note that ProgrammerError will only accept data files fulfilling the restrictions specified in the parameter summary. The absence of an attribute and/or invalid value for an attribute will result in an error message shown in the logger, and ProgrammerError will start with an empty json data file instead.

Here are some examples of corrupted data that is not accepted by ProgrammerError.

  //Absent attribute example: labNumValue attribute is missing
  labResultList" : [ {
  "actualScoreValue" : 10,
  "totalScoreValue" : 20
  }

  //Invalid attribute example: labNumValue is not between 1 to 13
  "labResultList" : [ {
  "labNumValue" : 20,
  "actualScoreValue" : 15,
  "totalScoreValue" : 20
  }

4. Student Features

4.1 Add Student: add

Adds a student to ProgrammerError with their student ID, class ID and email. Both the student ID and email must be unique.

Format: add -n <NAME> -sid <STUDENT_ID> -cid <CLASS_ID> -email <EMAIL>

4.2 Edit Student’s Details or Lab Result : edit

Edits the details or grade of an existing student in PE as specified by the INDEX_IN_LIST argument. The corresponding fields of the student will be updated according to the input arguments.

• Both the student ID and email must be unique.
• 1-indexing is used here as according to the displayed list.
• Any combination of the optional arguments can be provided.
• At least one of the optional argument must be provided.
• Take note that the parameters -ln and -s needs to be specified together.

Format: edit <INDEX_IN_LIST> [-n <NAME>] [-sid <STUDENT_ID>] [-cid <CLASS_ID>] [-email <EMAIL>] [-ln <LAB_NUM> -s <ACTUAL_SCORE>]

4.3 Delete Student: delete

Deletes the specified student from the PE. Take note that INDEX_IN_LIST is 1-indexed.

Format: delete <INDEX_IN_LIST>

4.4 Filter Students: filter

Filter the students in ProgrammerError based on the specified arguments provided (name, student ID, class ID and email).

• Any combination of the optional arguments can be provided.
• At least one of the optional argument must be provided.
• Arguments can be provided in any order and are case-insensitive.
• ProgrammerError will display the filtered list of students whose details matches all the specified arguments.
• The arguments are matched to the corresponding details as long as the details of the students contains the sequence of characters provided in the argument string.
• filter command does not follow the constraints as specified in parameter summary.

Format: filter [-n <NAME>] [-sid <STUDENT_ID>] [-cid <CLASS_ID>] [-email <EMAIL>]

Below shows an example when filter -cid B01 is executed with 4 students from class B01 filtered out.

4.5 Show Student Details: show

Shows a particular student’s details including their scores for each lab.

The student particular and lab results will be updated if other commands modify their fields.

Format: show <INDEX_IN_LIST>

4.6 List All Students: list

Displays a list of all students in the left panel. This list is ordered first by class ID followed by student name.

5. Lab Features

Note: As the following commands are mass operations, they might take slightly longer than usual.

5.1 Add Lab: addlab

Adds a lab to every student with the lab number and total score.

Format: addlab -ln <LAB_NUM> -ts <TOTAL_SCORE>

5.2 Edit Lab: editlab

Edits the details of an existing lab for every student.

• Any combination of the optional arguments can be provided.
• At least one of the optional argument must be provided.

Format: editlab -ln <LAB_NUM> [-nln <NEW_LAB_NUM>] [-ts <NEW_LAB_SCORE>]

5.3 Delete Lab: dellab

Deletes an existing lab from every student in ProgrammerError.

Format: dellab -ln <LAB_NUM>

Command Summary