fmaTest: fmaTest: S3 class for storing free text and results of...

In CALIBERfma: R interface to the Freetext Matching Algorithm

Description

The S3 class defines an object for storing the raw free text and the coded output from the Freetext Matching Algorithm, so that it can be displayed on screen in a convenient way. The analysis function doAnalysis can return a fmaTest object, or it can be created from files or data.frame objects containing the raw free text, associated medcodes and the Freetext Matching Algorithm output.

Usage

fmaTest(infile, outfile, medcodefile = NULL, lookupfolder = NULL)

## S3 method for class 'fmaTest'
print(x, ...)

Arguments

infile	character string for the path to an input file used for FMA analysis, or a data.frame with the input data, in the format required by doAnalysis.
outfile	character string to FMA output file or a data.frame with FMA structured output
medcodefile	character string for a file containing medcodes, or a data.frame containing the data, in the format required by doAnalysis.
lookupfolder	folder containing lookup files. If NULL, it is obtained from the option CALIBERfma_lookups_R.
x	a fmaTest object
...	Other arguments to pass to link{print.fmaTestElement}

Value

A fmaTest object. This is a list of fmaTestElement objects, each of which is a list with the following elements:

pracid	practice identifier
textid	text identifier
medcode	medcode associated with the text
readcode	Read code linked to the medcode associated with the text
readterm	Read term linked to the medcode associated with the text
text	unstructured free text
fma	structured output from the Freetext Matching Algorithm

Author(s)

Anoop Shah

See Also

print.fmaTestElement

CALIBERfma documentation built on May 2, 2019, 5:25 p.m.