Skip to content
Snippets Groups Projects
Commit 7a86fc5e authored by Andie Dewhurst's avatar Andie Dewhurst
Browse files

Updated README

parent e30032b4
No related branches found
No related tags found
1 merge request!1Updated README
......@@ -2,8 +2,50 @@
SaveTranscription is a script that manages saving transcription files to make it easier to review in the future.
## Usage
Run the code in MATLAB and follow any prompts you may see. For ease of use adhere the to the convention that the file you load into the Command Window is the lss file and the file exported from the app is the ls file.
## Download Instructions
To download the script, click the blue **Code** button, then select
**zip** to download the source code as a zip file.
Add explanation of variables
\ No newline at end of file
Save the file to your device’s "MatLabCode\MatlabFiles" folder.
Once **transcription-save-script-main.zip** has downloaded, right-click it and select **Extract All**. Delete “transcription-save-script-main” from the textbox and click **Extract**.
## Usage Instructions
Open a new instance of MATLAB, load the original signal set into the Command Window. Open the **Signal Labler** app, import **lss**. Proceed with transcription as usual.
When you’re ready to save your progress, click **Export**, and under **Labeled Signal Set** click **To Workspace**. The name of this export should either be “ls” or “ls” followed by a number, such as “ls1” or “ls5”. Click **Export**. The code is now installed and you may proceed with transcription.
* > This process exports your current progress to the workspace, effectively saving your progress. Export to the workspace regularly (every 10-20 audio files) to avoid losing your work. Give each **ls** file a unique name.
When you have exported all your progress and are ready to exit, close the ***Signal Labeler** app. Click **OK** when prompted to confirm that you want to exit (provided you have exported), and return to the main MatLab window.
* > Note: The code checks for changes between versions, so do not attempt to export a file that hasn't been changed*
Run **SaveTranscripts.m** by typing `SaveTranscripts` into the command window.
If prompted to add the folder to the path, do so.
If there are multiple **ls** versions in the workspace (which will be the case if you exported multiple times), you will be prompted to enter the number that corresponds to the most up to date **ls** file. Submit your response by hitting the **Enter** key.
Type your initials when prompted and hit **Enter** again.
When prompted, save the .mat file to the appropriate location with all the other in-progress files for that subject. Name the file using the usual format: `{#}_Transcript_{TaskName}_{SubjID}–InProg`.
***Once the code is done running and the file has saved, you may freely close MATLAB. Your progress has been saved.***
## Continue From An Existing Transcript
To continue from an in progress transcription, load the most recent version of the transcript into the command window.
In addition to the **lss** variable, there will be two additional files.
* `remainingFiles` --- Effectively a to-do list, which provides a record of all the files that still need to be transcribed. Double click on the variable in the workspace to view it. Drag the edge of the the column **File_Name** to expand it and view the complete file names.
* `reviewerInit` – The initials of the last person who modified the transcription.
The process is exactly the same as usual, but you will be able to play the audio in the same instance instead of having a second one open. ***Huzzah!***
Save your progress by following the steps outlined in "Usage Instructions"
The saving process is the same when you completely finish a transcription. The only difference is to name the resulting .mat file `{#}_Transcript_{TaskName}_{SubjID}–Complete`.
> Updated 250311 - AD
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment