egf_control_plot: Define Control Parameters for Plotting

In davidearn/epigrowthfit: Nonlinear Mixed Effects Models of Epidemic Growth

Define Control Parameters for Plotting

Description

Sets parameters controlling the graphical output of plot for objects of class egf. Supplied values override package defaults (retrievable as defaults <- egf_control_plot()), which in turn override global defaults set via par.

Below, x, type, time_as, and delta refer to the so-named arguments of plot.egf.

Usage

egf_control_plot(window, data, predict, asymptote, box, axis, title, doubling)

Arguments

window	a named list of arguments to rect affecting the appearance of fitting windows.
data	a named list of the form list(main, short, long). main is a named list of arguments to points affecting the appearance of observed data. short and long are alternatives to main used for counts over intervals shorter or longer than delta when type = "interval". short and long default to main (elementwise).
predict	a named list of the form list(value, ci). value and ci are named lists of arguments to lines and polygon affecting the appearance of predicted curves and corresponding confidence bands. ci[["col"]] defaults to value[["col"]] with added transparency.
asymptote	a named list of arguments to segments affecting the appearance of line segments drawn at y = <initial exponential growth rate> when type = "rt" and x[["model"]][["curve"]] = "logistic" or "richards".
box	a named list of arguments to box affecting the appearance of the box drawn around the plot region on the device.
axis	a named list of the form list(x, y). x and y are named lists of arguments to axis affecting the appearance of the bottom and left axes. When time_as = "Date", there are minor and major bottom axes. In this case, the major axis uses a modified version of x that tries to ensure that it is displayed below the minor axis in a slightly larger font.
title	a named list of the form list(main, sub, xlab, ylab). The elements are named lists of arguments to title affecting the appearance of plot (sub)titles and axis labels. sub[["adj"]] defaults to main[["adj"]].
doubling	a named list of the form list(legend, estimate, ci). The elements are named lists of arguments to mtext affecting the appearance of initial doubling times printed in the top margin.

Details

Setting an argument (or an element thereof in the case of nested lists) to NULL has the effect of suppressing the corresponding plot element.

Value

A named list containing the package defaults modified according to the arguments in the call.

davidearn/epigrowthfit documentation built on Feb. 22, 2025, 12:44 p.m.