Calgo - User Guide

The bar has two buttons, File and Help. The buttons allow you to exit the App by clicking the exit option under File, and to access the command guide by clicking the help option under Help. These buttons are there for your convenience, as exiting the app can also be done through the exit command. Likewise, accessing the command guides can be done using the help command.

Calgo listens to your requests and processes them. The Command Box is where you type commands into.

Should you mistype a command, Calgo will prompt you to use the right format. You can easily edit the wrong command inside the Command Box without needing to retype it entirely.

This is where Calgo displays textual updates as a result of processing your inputted commands. The Result Display will always show a response so you will know whether your commands have been correctly processed.

This section is labelled "Your Goal Information" on the GUI, and consists of two parts. The left box displays your target daily calorie goal (after you’ve set it using the goal command). The right box shows the amount of calories you still need to consume to meet your daily goal, or the amount you’ve exceeded by.

The Daily Goal Consumption updates automatically.

The Consumption Record displays the list of Food entries that you have consumed on that day. Although it only shows one day’s consumption, the stomach command lets you view other days' records.

It has three subsections:

This section contains a graph that shows a summary of your past seven day’s total calorie consumption. It displays data starting from the date of the current Consumption Record.

Example: Consumption Record currently shows 2020-04-12. Graph Display will thus show the daily calories consumed from 2020-04-06 to 2020-04-12.

This is a list of all Food entries you currently have in Calgo. Each Food entry will have a name, its nutritional information, and optional tags as set by you. The Food Record alternates colors between entries so that you can easily tell one entry apart from its neighbours.

This bar shows where Calgo reads system data from. You should not delete or modify these files.

(by Vineeth)

If you want to clear all the Food entries currently stored in your Food Record, this command will be useful to you.

Format: clear

Example:

Suppose that you want to drastically improve your diet. You decide to take a look at all of your Food entries currently in the Food Record but realise none of them fit into your new diet. To avoid the hassle of deleting each Food entry one by one, you decide to clear them. This is what you need to do:

First, type clear and then press enter, as shown in the above diagram.

Upon entering the command, all your Food entries in the Food Record will be deleted. This will result in an empty Food Record, as shown above. As mentioned previously, your data in the Consumption Record and Graph Display is left unchanged.

(by Zhang Xian)

If you no longer require Calgo to store a particular Food and its nutritional values for you, you can use the delete command to remove the specified Food from your Food Record.

Format: delete n/NAME

Example:

Say you want to remove a Food, Pizza, that already exists in your Food Record. This is how you can do it:

You should first enter delete n/pizza as input, and press enter. Note that delete n/Pizza also has the same effect.

Once the command has been entered, the Result Display shows the results of your command and the Food Record no longer shows a Food entry for Pizza.

If you want to exit the App, you can use the exit command.

Format: exit

(by Eugene)

Obtaining a portable copy of the current Food Record may be useful for various purposes. For instance, you can conveniently share your Food entries with friends, print the Food Record for future reference, or even adapt it to suit your personal cooking needs in the kitchen. Whatever the purpose, we have you covered with the export command.

The export command provides you with a neatly formatted, editable file that reflects all entries in the current Food Record. This file (named FoodRecord.txt) will be created in the data/exports folder.

Here are some key pointers for using the command:

Format: export
(any parameters entered are ignored)

Example:

Let’s suppose you wish to export the current Food Record so that you can print a copy for reference while cooking. Here’s how you can do it:

You should type in the command and press enter, as seen above.

Doing so, Calgo will show you a result message indicating the copy has been successfully generated. You can find this copy (named FoodRecord.txt) in the data/exports folder.

(by Eugene)

When you have many entries in the Food Record, it may be rather difficult to search for a particular one. This is where the find command comes in nicely.

The find command shows all Food entries that have a nutritional value matching what you specify. This can be the number of calories, or the number of grams of protein, carbohydrate or fat.

Alternatively, you can choose to search for a keyword which appears in any part of the name or in one of the tags associated with a particular Food entry.

Here are some key pointers:

Format: find [n/NAME] [cal/CALORIES] [p/PROTEINS] [c/CARBOHYDRATES] [f/FATS] [t/TAG]
(Reminder: choose only 1 parameter)

Examples:

Example 1: Say you want to use Calgo to search for a Food entry with 150 calories because you are looking for a light snack. Here is how you can do it:

You should type find cal/150, then press enter.

Once the command has been entered, the Result Display shows the results of your command and the Food Record displays the relevant entries with 150 calories.

Example 2: Say you wish to find entries which contain the keyword Cheese in their name, but your hand slipped and the keyboard only typed Chees. This is what happens:

You are likely to enter find n/Chees as the command input.

Once the command has been entered, the Result Display shows the results of your command and the Food Record shows the relevant entries which contain Chees in their name. This is not too bad, as you still obtain entries that will be largely relevant to Cheese. This shows that the find command can search for Food entries with incomplete keywords.

Example 3: Say you are lazy but wish to find entries containing the keyword sweet in their tag. Here is how you can do it:

You can type find t/swe as input, and then press enter.

Upon entering the command, the Food Record will display all entries which have the swe keyword present in any one of their tags. As you can search using incomplete keywords, the intended search for the sweet tag will also have its result shown.

Please note that the search is case-insensitive, an example being the resulting Sweet tag of Bandung. Moreover, as with Example 2, we allow for incomplete words to be used as search keywords.

(by Vineeth)

A healthy lifestyle is not achieved overnight. Calgo understands the importance of keeping the end in mind with regards to achieving your healthy lifestyle. Thus, to motivate you to put in consistent effort, you can set daily calorie goals for yourself using the goal command.

Here are some key pointers:

Format: goal GOAL

Example:

Let’s suppose you are a young adult who is trying to lose weight because your favourite jeans have become too tight. You search online for the ideal number of calorie you should consume daily to lose weight. A credible online source states it should be 1900 calories. Now, you want to reflect that daily calorie goal in Calgo. You can do that by following this simple step:

Type in goal 1900 and press enter, as shown above.

As you can see, the Daily Goal Display has updated to reflect your daily calorie goal. You can now track your meals and get immediate updates on the remaining amount of calories you have to consume for that day to achieve your goal.

(by Janice)

Whether you are an experienced Calgo user or a newcomer to the App, it can be hard to remember what a command’s usage and format is. Thus, the help command aims to remind you of them.

Here are some key pointers:

Format: help [COMMAND_WORD]

Example:

Let’s say you’ve forgotten how to add Food entries to your Consumption Record. You know there is a command called nom, but don’t recall its format. You can use the help command to obtain the format like so:

Type help, then press enter.

This creates a popup (the Help Window) with command guides. However that displays all the commands, which might make searching for only nom a bit daunting. Instead, you can type help nom, then press enter.

As you can see, the Help Window popup now only shows the command guide for nom.

(by Eugene)

With a large number of entries in the Food Record, you may remember that we can use the find command to display only the relevant Food entries. Once we are done with the search, we will eventually want to view all entries again. This is where the list command comes in handy.

The list command resets the display accordingly to show all entries in the Food Record. These entries will be neatly sorted, just as the Food Record previously appeared:

Format: list
(any parameters entered are ignored)

Example:

Let’s say you want to view all entries again after performing a find n/Chicken command. You can do the following:

Type list as input, then press enter.

The Result Display will then indicate the result of your command, and the Food Record will now show all Food entries once again.

(by Ruicong)

Your Consumption Record stores everything that you have consumed. With the nom command, you can add Food that you have consumed on a certain day to your Consumption Record.

The nom command helps you to keep track of your consumption on certain date.

Below is some information to keep in mind:

Format: nom n/NAME [d/DATE] [portion/PORTION][r/RATING]

Example:

Suppose you want to have a Cheeseburger today and have already stored its nutritional content in Food Record. Since you just want to dig in as soon as possible, yet still want to jot your meal down, you decide to enter the simplest command possible. Here’s how you do it:

First, enter nom n/Cheeseburger as input and press enter.

Once you enter the command, the Result Display will inform you that the food has been consumed. The Consumption Record panel and Graph Display are updated to reflect your latest consumption.

(by Vineeth)

Why stop at keeping track of your meals? Go a step further and use your past consumption patterns to learn how to improve your eating habits. Moreover, won’t it be convenient if you can automatically generate tips on how to improve? This is exactly what the report command can help you with!

Given a date, the report command analyses your consumption pattern in that day to generate relevant statistics and helpful insights for improving your diet. You no longer have to tediously calculate the total amount of calories you consumed in a day. Calgo does it for you, instantly!

Refer to the list below for the various types of insights that you can easily obtain from the report command.

Format: report d/DATE

Example:

Let’s suppose you had a buffet on 27th of April 2020 and you managed to nom lots of exciting Food into your Consumption Record. It is now the end of the day and you want to look back and find out how you fared. This is what you can do:

First, type report d/2020-04-27 and press enter, as shown above.

Second, go to the data/reports folder and open 2020-04-27_report.txt. You will see a report that looks similar to the one in the above screenshot.

The following steps breakdown what information is included in each section of the report.

The first section is the Report Header, which states the date of your consumption pattern that is being analysed in the report. In this case, your food consumption pattern on the 27th of April 2020 is analysed in the displayed report screenshot.

The second section is Your Goal Information. This section reminds you of the daily calorie goal that you have set for yourself.

The third section is Food-wise Statistics. As the name suggests, this section provides you with relevant statistics for every Food entry in your Consumption Record of the given day. In this case, you can see a variety of Food entries that you have tracked from your buffet experience. For each Food entry, the report displays the name of the Food, the total number of portions you consumed and the total amount of calories from that Food. You can use this information to realise what Food you may be over-consuming.

The fourth section is Aggregate Statistics, which shows you the total amount of calories, protein, carbohydrates and fat that you have consumed on the given day. This section could be particularly helpful if you are interested in tracking your total nutritional intake each day.

The fifth section is called Insights for You. In this section, Calgo uses your daily calorie goal to explain how close you were to achieving it. For you to continually improve your eating habits, Calgo, like any other friend, pushes you with motivating messages and congratulates you if you achieved the goal. In this case, as you exceeded the daily calorie goal by 959 calories, Calgo provides you with some reassurance that you can do better the next day to ensure that you do not give up.

The penultimate section is Suggestions for You. In this section, Calgo analyses your Consumption Record of the past week from the given date to find out what you can do to improve your eating habits. Calgo does this by using a mix of your ratings and quantity consumed of each Food to intelligently infer what your favourite Food is. It then analyses if you can continue to keep your favourite Food in the past week in your diet based on your daily calorie goal. Over time, through Calgo’s smart suggestions, you will eventually have a diet consisting of your favourite Food entries that are compatible with your goal. How awesome is that!

The final section is the Report Footer, which informs you that the report has concluded. This is the part where you realise that Calgo provides you with so many key insights in such a neatly organised and compact document.

(by Ruicong)

Do you find it a hassle to constantly recall what you ate? Can’t seem to remember what you had for lunch last week?

You can now remember everything, because Calgo remembers for you. The stomach command displays all of the Food you ate on a particular day, showing it in the Consumption Record.

For a more detailed statistical report with nutritional values of Food consumed, you can refer to the section on the report command here.

Here are some key pointers:

Format: stomach [d/DATE]

Example: If you want to see what you have consumed on 12 April 2020, here’s how you can do it:

Type the command stomach d/2020-04-12 as input and press enter.

The Consumption Record will display all the Food you have consumed on 12 April 2020. You can also see that Daily Goal Display has updated to show the amount of calories you have consumed on 12 April 2020, relative to your daily goal.

(by Zhang Xian)

Tired of searching for nutritional information online for the same food repeatedly? Frustrated of having no convenient place to note it down?

The update command allows you to enter new Food entries into Calgo’s Food Record. Moreover, as a smart feature, Calgo detects if there is an existing Food entry with the same name. If so, it will edit that Food entry with new information provided by you.

Here are some key pointers:

Format: update n/NAME cal/CALORIES p/PROTEINS c/CARBOHYDRATES f/FATS [t/TAGS]

Examples:

Example 1: Suppose you want to create a Food entry for Mee Goreng in Calgo. After searching online for the nutritional values for Mee Goreng, you found that Mee Goreng has 418 calories, 8g of protein, 58g of carbohydrate and 17g of fat. Here’s how you update your new Food, Mee Goreng, into your Food Record:

You should type update n/Mee Goreng cal/418 p/8 c/58 f/17 and press enter.

Once the command has been entered, the Result Display shows the result of your command and the Food Record has been updated with a new Food, Mee Goreng.

Example 2: Perhaps you realised that there was an error with the nutritional values keyed in for an existing Food, Mee Goreng, inside your Food Record. You wish to update the protein value for Mee Goreng to a new value of 10g. This is how you can do it:

Type update n/Mee Goreng cal/418 p/10 c/58 f/17 as input and press enter.

Once the command has been entered, the Result Display shows the result of your command and the Food, Mee Goreng, in Food Record has been updated with a new protein nutritional value of 10g.

Example 3: Suppose you want to update a new Food, Char Kuay Teow, into the Food Record. However, you typed the name of the Food in hurry and did not capitalise some letters properly. Instead of "Char Kuay Teow", you accidentally typed "char KUay TeoW" in the name field. You can do this:

You can then type update n/char KUay TeoW cal/200 p/20 c/22 f/30 t/greasy and press enter.

Calgo automatically formats the name of your Food for you to proper case. Hence, you see that instead of a hideous "char KUay TeoW" being updated into the Food Record, your new Food item is updated as "Char Kuay Teow".

(by Ruicong)

If you have overstated an amount previously (or actually vomited from over-consumption), you can amend existing consumption records using the vomit command.

Format: vomit num/INDEX [d/DATE] [portion/PORTION]

Example: Let’s say you ordered a glass of Bandung and previously used nom with PORTION set to 1. However, because the drink was too sweet, you only finished half a glass, you can use vomit to adjust your Consumption Record. Here’s how you can do this:

You should enter vomit num/1 portion/0.5, then press enter.

As you can see from the Consumption Record panel, the portion has been reduced to 0.5. The Graph Display also reflects a drop in calories.