diff --git a/README.md b/README.md index a4141202022f98eab484df18c30b20cf1725b90b..7851ca0ab3a240ffc1cf0d8e47847773323628df 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ SaveTranscription is a script that manages saving transcription files to make it To download the script, click the blue **Code** button, then select **zip** to download the source code as a zip file. -Save the file to your device’s "MatLabCode\MatlabFiles" folder. +Move 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**. @@ -18,7 +18,7 @@ When you’re ready to save your progress, click **Export**, and under **Labeled * > 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. +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. @@ -30,22 +30,30 @@ 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_{ReviewerInitials}`. -***Once the code is done running and the file has saved, you may freely close MATLAB. Your progress has been saved.*** +**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 +## Continue From A Saved 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. + * > Note that if there are any audio clips that were left blank (such as when there is no audio that could be labeled), these will still show up in the **remainingFiles**, since there hasn't any been any changes from the original that the code can identify. * `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!*** +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_{ReviewerInitials}`. -> Updated 250311 - AD \ No newline at end of file +## Start Using SaveTranscriptions for an exisiting InProg Transcription +To begin using the save function for a transcription that you're already in the middle of that hasn't been using this script up until this point... + +Open the script in MATLAB. Import both the original, unedited transcript and the most up-to-date in-progress version. Run the code and follow all of the instrustions as prompted. + +Once the file has saved successfully and the code is done running, import the newly saved into MATLAB and you are ready to go with transcription. + +> Updated 250319 - AD \ No newline at end of file