analyzeFolder: Analysis of all corneal topography files in a folder

Description Usage Arguments Details Value Examples

View source: R/wrapperFunctions.R

Description

This function analyzes all corneal topography files that are stored in a common folder. It is equivalent to use analyzeFile on each file in the folder, and then binding the results.

Usage

1
2
3
4
5
6
analyzeFolder(
  path,
  fileExtension = "txt",
  individualPlots = FALSE,
  summaryPlot = FALSE
)

Arguments

path

The path of a folder which contains corneal topography files, as exported by Placido disks corneal topographers.

fileExtension

The file extension of the corneal topography files in the folder ("txt" by default).

individualPlots

An optional logical parameter (by default, FALSE) indicating whether the plot for each file should be displayed or not.

summaryPlot

An optional logical parameter (by default, FALSE) indicating whether a summary plot should be displayed or not.

Details

This function assumes all files in the folder that have the extension given by the argument fileExtension ("txt", by default) are corneal topography files and are to be processed. The result is a data.frame in the same format yield by computePlacidoIndices or analyzeFile, but with as many rows as matching files were found in the folder.

More details about supported file formats can be found in vignette("topographersDataFormat", package = "rPACI"), and about using rPACI in vignette("packageUsage", package = "rPACI").

Value

A data.frame containing the Placido irregularity indices as well as the diagnose, with as many rows as data files in the folder, and columns:

Diagnose A text label indicating the diagnose, according to the value of GLPI
NBI The value of NBI index (in the range 0-100).
GLPI The value of GLPI index (in the range 0-100).
PI_1 The value of PI_1 index (usually in the range 0-150).
PI_2 The value of PI_2 index (usually in the range 0-150).
PI_3 The value of PI_3 index (usually in the range 0-150).
SL The value of SL index (usually in the range 0-150).
AR_1 The value of AR_1 index (usually in the range 0-150).
AR_2 The value of AR_2 index (usually in the range 0-150).
AR_3 The value of AR_3 index (usually in the range 0-150).
AR_4 The value of AR_4 index (usually in the range 0-150).
AR_5 The value of AR_5 index (usually in the range 0-150).

Examples

1
2
3
4
5
# This analyzes together all the corneal topography example files included in rPACI:
## Not run: 
analyzeFolder(system.file("extdata",package="rPACI"))

## End(Not run)

rPACI documentation built on Nov. 4, 2021, 1:08 a.m.