plot_circMLE {CircMLE}R Documentation

plot_circMLE

Description

Plot the observed data and specific model from circ_mle output

Usage

plot_circMLE(data, table, model, bins, shrink, col, lwd, lty)

Arguments

data

A vector of class 'circular'

table

A list containing the output from the circ_mle function

model

The name of the model to be plotted. (default = first model of "table")

bins

The number of bins for the circular histogram. (defualt = 18)

shrink

The value by which to shrink the size of the plotted circle. Larger numbers shrink the circle, smaller numbers expand the circle. (default = 1.5)

col

Vector of colors used for plotting, up to four colors can be specified. The order is: histogram color, mean vector color, model density color, predicted mean direction(s) color(s). (default = c("grey", "red", "black", "black"))

lwd

Vector of line weights used for plotting, up to 3 weights can be specified. The order is: mean vector weight, model density weight, predicted mean direction(s) weight(s). (default = c(2, 2, 2))

lty

Vector of line weights used for plotting, up to 3 weights can be specified. The order is: mean vector weight, model density weight, predicted mean direction(s) weight(s). (default = c("solid", "dashed", "dashed"))

Value

A plot is returned to the default image device.

Note

In the resulting plot, the observed vector length is equal to rho (vector strength). However, the predicted direction(s) from the model are drawn with vector length of 1. Also, if the model "M1" is selected, by definition no predicted direction is plotted.

Examples

testdata = circular::rvonmises(100, mu = circular::circular(pi), kappa = 3)
out = circ_mle(testdata)
plot_circMLE(testdata, out)
plot_circMLE(testdata, out, model = "M4A")

[Package CircMLE version 0.3.0 Index]