analyzeDataset {rPACI} | R Documentation |
Analysis of a single corneal topography dataset
Description
Analyze a corneal topography dataset (a data.frame
in the rPACI format). This function combines the two
operations of functions computePlacidoIndices and plotSingleCornea. It assumes a valid
rPACI data.set
is already available on memory.
Usage
analyzeDataset(dataset, drawplot = TRUE)
Arguments
dataset |
A corneal topography dataset, loaded from a file using the function readFile, simulated using simulateData, or by other ways (as long as it meets the dataset requirements). |
drawplot |
An optional parameter indicating whether a plot of results should be displayed or not (by default, |
Details
The dataset is checked to verify it matches the rPACI format: it must contain 3 columns: x, y (with the X and Y Cartesian
coordinates of data points) and ring index (1, 2, ...). The ring index column must contain positive integer numbers.
The dataset must not contain NA
values. Finally, all the rings must contain the same number of data points.
More details about supported file formats can be found in
vignette("topographersDataFormat", package = "rPACI")
,
and about using rPACI
in vignette("packageUsage", package = "rPACI")
.
Examples
# Generate a sample dataset
dataset = simulateData(rings = 15, ringRadiiPerturbation = 0.7)
# Analyze this dataset:
analyzeDataset(dataset)