rose_stats: Show Average Direction and Spread in Rose Diagram

In tectonicr: Analyzing the Orientation of Maximum Horizontal Stress

Show Average Direction and Spread in Rose Diagram

Description

Adds the average direction (and its spread) to an existing rose diagram.

Usage

rose_stats(
  x,
  weights = NULL,
  axial = TRUE,
  avg = c("mean", "median", "sample_median"),
  spread = c("CI", "fisher", "sd", "IQR", "mdev"),
  avg.col = "#85112AFF",
  avg.lty = 2,
  avg.lwd = 1.5,
  spread.col = ggplot2::alpha("#85112AFF", 0.2),
  spread.border = FALSE,
  spread.lty = NULL,
  spread.lwd = NULL,
  add = TRUE,
  ...
)

Arguments

x	Data to be plotted. A numeric vector containing angles (in degrees).
weights	Optional vector of numeric weights associated with x.
axial	Logical. Whether data are uniaxial (axial=FALSE) or biaxial (TRUE, the default).
avg	character. The average estimate for x. Either the circular mean ("mean", the default), the circular Quasi Median ("median"), or the sample median ("sample_median").
spread	character. The measure of spread to be plotted as a fan. Either 95% confidence interval ("CI", the default), Fishers confidence interval ("fisher"), the circular standard deviation ("sd"), the Quasi interquartile range on the circle ("IQR"), or the sampke median deviation ("mdev"). NULL if no fan should be drawn.
avg.col	color for the average line
avg.lty	line type of the average line
avg.lwd	line width of the average line
spread.col	color of the spread fan
spread.border	logical. Whether to draw a border of the fan or not.
spread.lty	line type of the spread fan's border
spread.lwd	line width of the spread fan's border
add	logical.
...	optional arguments to circular_plot() if add is FALSE.

Value

No return value, called for side effects

See Also

rose() for plotting the rose diagram, and circular_mean(), circular_median(), circular_sample_median(), confidence_interval(), confidence_interval_fisher(), circular_sd(), circular_IQR(), circular_sample_median_deviation() for statistical parameters.

Examples

data("san_andreas")
rose(san_andreas$azi, weights = 1 / san_andreas$unc, muci = FALSE)
rose_stats(san_andreas$azi, weights = 1 / san_andreas$unc, avg = "sample_median", spread = "mdev")

tectonicr documentation built on Sept. 11, 2024, 6:05 p.m.