plot_timeseries: plot_timeseries

View source: R/timeseries.R

plot_timeseriesR Documentation

plot_timeseries

Description

function to plot timeseries data, a corresponding histogram and an error shading for an error analysis via uwerr

Usage

plot_timeseries(dat, ylab, plotsize, titletext, hist.by, stat_range = c(1,
  length(dat$y)), pdf.filename, name = "", xlab = "$t_\\mathrm{MD}$",
  hist.probs = c(0, 1), errorband_color = rgb(0.6, 0, 0, 0.6),
  type = "l", uwerr.S = 2, smooth_density = FALSE, periodogram = FALSE,
  debug = FALSE, uw.summary = TRUE, ...)

Arguments

dat

Timeseries to analyse.

ylab

Y-axis label.

plotsize

Width and Height of plot.

titletext

Text in the plot title.

hist.by

Numeric. Stepping to compute the histogram breaks.

stat_range

Optional integer vector of length 2. Start and end indices of the subset of dat to be plotted. If left empty, all of dat will be plotted.

pdf.filename

String. PDF filename.

name

String. Timeseries name.

xlab

X-axis label.

hist.probs

Optional numeric vector of length 2. Probability extrema to limit the width of the histogram or smoothed density plots. By default all data is used. Note: this has not effect on the analysis as a whole or other plots.

errorband_color

String. Colour of the error band.

type

String. Plot type, see plot for details.

uwerr.S

Numeric. S of the uwerr method to be used.

smooth_density

Boolean. Instead of plotting a histogram, use a smoothed density.

periodogram

Boolean. Whether to show a periodogram.

debug

Boolean. Generate debug output.

uw.summary

Boolean. Generate an uwerr summary plot.

...

Generic graphical parameters to be passed on.

Value

Returns a data.frame with named columns val, dval, tauint, dtauint, Wopt and stringsAsFactors, see uwerr.


hadron documentation built on Sept. 9, 2022, 5:06 p.m.