ArchaeoPhases (version 1.8)

MultiDatesPlot: Plot of credible intervals or HPD regions of a series of events

Description

Plot of credible intervals or HPD regions of a series of events

Usage

MultiDatesPlot(
  data,
  position,
  level = 0.95,
  roundingOfValue = 0,
  intervals = "CI",
  order = "default",
  title = "Plot of intervals",
  subtitle = NULL,
  caption = "ArchaeoPhases",
  labelXaxis = "Calendar Year",
  labelYaxis = NULL,
  height = 7,
  width = 7,
  units = "in",
  x.min = NULL,
  x.max = NULL,
  x.scale = "calendar",
  elapsed.origin.position = NULL,
  dumbbell.size = 3,
  dot.guide = FALSE,
  dot.guide.size = 0.25,
  y.grid = FALSE,
  file = NULL,
  newWindow = TRUE,
  print.data.result = FALSE
)

Arguments

data

Data frame containing the output of the MCMC algorithm.

position

Numeric vector containing the position of the column corresponding to the MCMC chains of interest.

level

Probability corresponding to the level of confidence.

roundingOfValue

Integer indicating the number of decimal places to be used.

intervals

One of "CI" for credible intervals, or "HPD" for highest posterior density intervals.

order

Order of the events. If "default" then the order of the csv file is followed, if "increasing" events are ordered by the HPDInf of the first region or the CIInf

title

Title of the plot.

subtitle

Subtitle of the plot.

caption

Caption of the plot.

labelXaxis

X axis label of the plot.

labelYaxis

Y axis label of the plot.

height

Height of the plot in units.

width

Width of the plot in units.

units

A string recognized by ggsave() function, one of "in", "cm", "mm".

x.min

Minimum x axis value.

x.max

Maximum x axis value.

x.scale

One of "calendar" for calendar years, "BP" for years before present, or "elapsed" for years after a specified origin.

elapsed.origin.position

Position of the column corresponding to the origin for elapsed time calculations.

dumbbell.size

Size of the symbols used to plot events.

dot.guide

Switch for guides from y-axis to plot symbols.

dot.guide.size

Size of the dot guides.

y.grid

Switch for horizontal grids.

file

Name of the file to be saved. If NULL then no plot is saved.

newWindow

Whether the plot is drawn within a new window or not.

print.data.result

If TRUE, the list containing the data to plot will be returned.

Value

NULL, called for its side effects. If print.data.result = TRUE then a list containing the data to plot will be returned.

Examples

# NOT RUN {
  data(Events)
  MultiDatesPlot(Events, c(2, 4, 3), level = 0.95, intervals = "CI",
                 title = "Plot of CI intervals")
  MultiDatesPlot(Events, c(2, 4, 3), level = 0.95, intervals = "HPD",
                 title = "Plot of HPD intervals")
  MultiDatesPlot(Events, c(2, 4, 3), level = 0.95, intervals = "HPD",
                 order = "increasing")

# }