1.4.8. Keeping track of your work session

It is possible to keep track of everything done during a MATLAB session with the diary command.

>> diary

or give a name to a created file,

>> diary FileName

where FileName could be any arbitrary name you choose.

The diary command in MATLAB is a powerful tool that allows you to record all of your inputs and outputs during a session. When you use the command diary, MATLAB starts to save everything you type and the results it returns in the current session. If you wish to save this session to a specific file, you can use diary FileName, where FileName can be any name you choose. This means you can create a log of your work, which is very helpful for keeping notes or reviewing your work later.

Think of the diary command as a personal journal. Just like you might write down your thoughts and daily activities in a diary to keep track of them, the diary command lets you keep a record of your MATLAB session. Imagine working on a complex project, and you want to remember every calculation and result. Using diary, you ensure you won’t forget any important steps.

The function diary is useful if you want to save a complete MATLAB session. They save all input and output as they appear in the MATLAB window. When you want to stop the recording, enter diary off. If you want to start recording again, enter diary on.

You can control the diary function easily as it allows you to start and stop recording your session. By entering diary off, MATLAB stops writing all inputs and outputs to the diary file. Conversely, if you wish to continue recording after having stopped, you simply use diary on. This flexibility lets you manage what you want to log, which is particularly useful if you only want to save significant portions of your work.

Consider working on a research paper. You might write detailed sections and later decide some parts need edits. The diary function is like writing in drafts: when you stop writing, you can go back and add notes or sections again whenever you feel it's necessary. It helps in tracking progress without getting overwhelmed by unnecessary details.

The file that is created is a simple text file. It can be opened by an editor or a word processing program and edited to remove extraneous material, or to add your comments. You can use the function type to view the diary file or you can edit in a text editor or print.

After you finish a session and save it using the diary command, the resulting file is a plain text file. This file can be opened in any text editor (like Notepad or Word) where you can review, edit, and add comments. For example, if some of the outputs are not needed, you can delete them, or if you want to explain certain steps, you can add your written notes accordingly. You can also print the file if you need to share or present your work.

Think of the diary file like a transcription of a lecture. After the lecture, the recording (your diary file) can be reviewed, edited for clarity, and rewritten to highlight key points. This means that at the end of a MATLAB session, you can go through your ‘lecture notes’, tidy them up, and make them more useful for future reference.

This command is useful, for example in the process of preparing a homework or lab submission.

The diary function in MATLAB is particularly advantageous when preparing assignments or lab reports. Instead of having to manually write down computations or results, you have a ready-made transcript of your entire MATLAB session. This not only saves you time but helps ensure accuracy in your submissions, as you can simply edit the captured material before finalizing your work.

Imagine you are working on a science experiment and taking notes throughout the process. Utilizing the diary function is like having a recorder that captures every step you take and every observation you make. When it comes time to write your report, you can refer back to the recordings and notes, ensuring that you don’t miss any important aspects and can provide a detailed account of your findings.

--