evalTransc: Check whether a Transcription Matches the Correct Value

In abbey-thomas/speechcollectr: R Tools for Collecting Speech Production & Perception Data

Check whether a Transcription Matches the Correct Value

Description

Check whether a Transcription Matches the Correct Value

Usage

evalTransc(filename = NULL, text, correct, alphaOnly = TRUE, matchCase = FALSE)

Arguments

filename	An RDS file output from transcribeServer() OR an RDS file containing a single character string representing the entered transcription.
text	A character string to test against the correct transcription. Not necessary if filename is supplied.
correct	A character string of the correct transcription to which text or filename will be compared.
alphaOnly	Boolean. Should the transcription be compared only in alphabetic characters entered, ignoring any spaces, punctuation, or digits? Defaults to TRUE.
matchCase	Boolean. Should the comparison be case-sensitive? Defaults to FALSE.

Details

This function is likely not very useful on its own, except for post-processing of transcriptions entered with transcribeUI() and transcribeServer(). This function serves as a base for its interactive version evalTranscServer, for giving feedback to a participant based on a transcription they've entered.

Value

A Boolean value indicating whether the transcription in text or filename matches the value given in correct (=1) or not (=0).

Examples

# Using the filename argument
transc <- "this is a sample transcription"
saveRDS(transc, "foo.rds")

is.correct <- evalTransc(filename = "foo.rds",
                         correct = "This is a sample transcription.")
print(is.correct)

# Using the text argument instead
# Play with the values matchCase and alphaOnly to observe changes in the returned value.
is.correct <- evalTransc(text = "this is a sample transcription",
                         correct = "This is a sample transcription.")
print(is.correct)

abbey-thomas/speechcollectr documentation built on Feb. 8, 2024, 12:29 a.m.