spatial_plots: Plots for statistical power estimates of the SRR function

In sparrpowR: Power Analysis to Detect Spatial Relative Risk Clusters

Plots for statistical power estimates of the SRR function

Description

Create multiple plots of output from spatial_data, spatial_power and jitter_power functions.

Usage

spatial_plots(
  input,
  p_thresh = 0.8,
  cascon = FALSE,
  n_sim = 1,
  cols = c("#000000", "#CCCCCC", "#FF0000", "#0000FF"),
  chars = c(1, 1),
  sizes = c(1, 1),
  scale = 1,
  plot_pts = TRUE,
  plot_title = TRUE,
  plot_text = FALSE,
  plot_axes = FALSE,
  plot_square = FALSE,
  horizontal = TRUE,
  ...
)

Arguments

input	An object of class "ppplist" from the spatial_data function or an object of class "list" from the spatial_power or jitter_power functions.
p_thresh	A numeric value between 0 and 1 (default = 0.8) for the power threshold.
cascon	Logical. If TRUE, displays the statistical power to detect case clusters and control clusters (two-tailed hypothesis). If FALSE (the default), displays the statistical power to detect case clusters only (one-tailed, lower-tail hypothesis).
n_sim	Integer. The number of simulated iterations to plot. The default is one (1).
cols	Character string of length four (4) specifying the colors for plotting: 1) insufficiently powered, 2) sufficiently powered, 3) case locations, 4) control locations. The default colors in hex are c("#000000", "#CCCCCC", "#FF0000", "#0000FF") or c("grey0", "grey80", "red", "blue").
chars	Vector of integers or character string of length two (2) for symbols of case and control locations. Default is c(1,1).
sizes	Vector of integers of length two (2) for the size of the symbols for case and control locations. Default is c(1,1).
scale	Integer. A graphical expansion factor (default is 1) for text (and point) size within plots. Intended for scaling plot features with plot resolution.
plot_pts	Logical. If TRUE (the default), the points from the first simulation iteration will be added to second plot. Not if FALSE.
plot_title	Logical. If TRUE (the default), a title will be included in the plot(s). Not if FALSE.
plot_text	Logical. If TRUE, the local statistical power will be printed at each grid cell. Not if FALSE (the default).
plot_axes	Logical. If TRUE, the axes with labels will be included in the plot(s). Not if FALSE (the default).
plot_square	Logical. If TRUE, the plot will have margins with similar units. Not if FALSE (the default).
horizontal	Logical. If TRUE (the default), the color key will be displayed horizontally, below the plots. If FALSE, the color key will be displayed vertically, to the right of the plots.
...	Arguments passed to plot.ppp and image.plot for additional graphical features.

Value

This function produces up to three plots: 1) example input, 2) local power, and 3) local power above a threshold if the input is from the spatial_power r jitter_power functions. If the input is from the spatial_data function, this function will only display the first plot.

Examples

 # run spatial_power(), jitter_power(), or spatial_data()
 sim_power <- spatial_power(x_case = c(0.25, 0.5, 0.75),
                            y_case = c(0.75, 0.25, 0.75),
                            samp_case = "MVN", 
                            samp_control = "MVN",
                            x_control = c(0.25, 0.5, 0.75),
                            y_control = c(0.75, 0.25, 0.75),
                            n_case = 100,
                            n_control = c(100,500,300),
                            s_case = c(0.05,0.01,0.05),
                            s_control = 0.05,
                            verbose = FALSE)
               
 # run spatial_plots()
 spatial_plots(input = sim_power)

sparrpowR documentation built on Feb. 16, 2023, 5:53 p.m.