R: Bland-Altman plotting function, using basic R drawing...

blandr.plot.rplot

R Documentation

Bland-Altman plotting function, using basic R drawing functions

Description

Draws a Bland-Altman plot using data calculated using the other functions, using the in-built R graphics

Usage

blandr.plot.rplot(statistics.results, plot.limits, method1name = "Method 1",
  method2name = "Method 2",
  plotTitle = "Bland-Altman plot for comparison of 2 methods",
  annotate = FALSE, ciDisplay = TRUE, ciShading = TRUE,
  normalLow = FALSE, normalHigh = FALSE, point_size = 0.8)

Arguments

`statistics.results`	A list of statistics generated by the blandr.statistics function: see the function's return list to see what variables are passed to this function
`plot.limits`	A list of statistics generated by the blandr.plot.limits function to define the extent of the x- and y- axes: see the function's return list to see what variables are passed to this function
`method1name`	(Optional) Plotting name for 1st method, default 'Method 1'
`method2name`	(Optional) Plotting name for 2nd method, default 'Method 2'
`plotTitle`	(Optional) Title name, default 'Bland-Altman plot for comparison of 2 methods'
`annotate`	(Optional) TRUE/FALSE switch to provides annotations to plot, default=FALSE
`ciDisplay`	(Optional) TRUE/FALSE switch to plot confidence intervals for bias and limits of agreement, default=TRUE
`ciShading`	(Optional) TRUE/FALSE switch to plot confidence interval shading to plot, default=TRUE
`normalLow`	(Optional) If there is a normal range, entering a continuous variable will plot a vertical line on the plot to indicate its lower boundary
`normalHigh`	(Optional) If there is a normal range, entering a continuous variable will plot a vertical line on the plot to indicate its higher boundary
`point_size`	(Optional) Size of marker for each dot. Default is cex=0.8

Author(s)

Deepankar Datta <deepankardatta@nhs.net>

Examples

# Generates two random measurements
measurement1 <- rnorm(100)
measurement2 <- rnorm(100)

# Generates a basic plot
# Do note the blandr.plot.rplot function wasn't meant to be used on it's own
# and is generally called via the bland.altman.display.and.draw function

# Passes data to the blandr.statistics function to generate Bland-Altman statistics
statistics.results <- blandr.statistics( measurement1 , measurement2 )
# Passed data to the blandr.plot.limits function to generate plot limits
plot.limits <- blandr.plot.limits( statistics.results )

# Generates a basic plot, with no optional arguments
blandr.plot.rplot( statistics.results , plot.limits )

# Generates a basic plot, with title changed
blandr.plot.rplot( statistics.results , plot.limits , plotTitle = 'Bland-Altman example plot' )
# Generates a basic plot, with title changed, and confidence intervals off
blandr.plot.rplot( statistics.results , plot.limits , plotTitle = 'Bland-Altman example plot' ,
ciDisplay = FALSE , ciShading = FALSE )