GENEAsphere (version 1.5.1)

plotSegmentEllipse: Plot an ellipse representation of a segment 'confidence interval'

Description

Create an ellipse representing a 'confidence interval' of a given segment and plot a projected representation.

Usage

plotSegmentEllipse(segmentationCSV, plotRows, projection = "aitoff",
  col = "red", singlePlot = TRUE, confidenceLevel = 0.05,
  alpha = thresholds, wrap = FALSE, greyGrid = FALSE)

Arguments

segmentationCSV

The file path to the csv file created from the segmentation process containing all features.

plotRows

The rows from the csv file to be used to simulate plotting data.

projection

The type of projection to be used. Can be any of those used by mapproject in the package mapproj.

col

A vector of character strings to indicate the colour of each ellipse. If the number of segments is greater than the length of the colours vector then colurs will be repeated.

singlePlot

(logical) Indicates wether all rows should be added to one plot.

confidenceLevel

The alpha value for the confidence interval. A value of 0.05 corresponds to a 95% confidence interval.

alpha

The alpha level to use for plotting colours.

wrap

(logical) Indicating whether segments should be wrapped around the sphere or cropped. By default ellipses are cropped.

greyGrid

(logical) Should the plot be created with a white background and grey grid or a grey background with white grid (default).

Value

There is no return to the console. As a side effect a graphic is created.

Details

This function uses the mean and standard deviation estimates for elevation and rotation of a segment to determine a confidence interval for each direction. This is then used to generate an ellipse representing the two dimensional confidence region. This ellipse is plotted onto a projected representation of the sphere. Required columns are:

1. UpDown.median

2. UpDown.mad

3. Degrees.median

4. Degrees.mad

Examples

# NOT RUN {
segmentationCSV = system.file("data", "SegData.csv", package = "GENEAsphere")
plotRows = c(1:1)
plotSegmentEllipse(segmentationCSV, plotRows, projection = "aitoff", 
  col = "red", singlePlot = TRUE, confidenceLevel = 0.05, 
  alpha = thresholds, wrap = FALSE, greyGrid = FALSE)
 
# }