plot.global_envelope: Plot method for the class 'global_envelope'

Description Usage Arguments See Also

View source: R/envelopes.r

Description

Plot method for the class 'global_envelope'

Usage

1
2
3
4
5
6
7
8
## S3 method for class 'global_envelope'
plot(x, plot_style = c("basic", "fv", "ggplot2"),
   dotplot = length(x$r)<10,
   main, ylim, xlab, ylab, use_ggplot2,
   color_outside = TRUE, env.col = 1, base_size = 15,
   labels = NULL, add = FALSE, digits=3,
   level = 1, separate_yaxes = TRUE, max_ncols_of_plots = 2,
   nticks = 5, ...)

Arguments

x

An 'global_envelope' object

plot_style

One of the following "basic", "fv" or "ggplot2". The option "basic" (default) offers a very basic global envelope plot. The option "fv" utilizes the plot routines of the function value table fv.object. For "ggplot2", a plot with a coloured envelope ribbon is provided. Requires R library ggplot2. The option "fv" is currently only available for tests with one test function, whereas the other true allow also tests with several tests functions.

dotplot

Logical. If TRUE, then instead of envelopes a dot plot is done. Suitable for low dimensional test vectors. Only applicable if plot_style is "basic". Default: TRUE if the dimension is less than 10, FALSE otherwise.

main

See plot.default. A sensible default exists.

ylim

See plot.default. A sensible default exists.

xlab

See plot.default. A sensible default exists.

ylab

See plot.default. A sensible default exists.

use_ggplot2

Logical, whether plot_style is "ggplot2" or not. Outdated, use the argument plot_style instead.

color_outside

Logical. Whether to color the places where the data function goes outside the envelope. Currently red color is used. Relevant only for plot_style = "basic".

env.col

The color for the envelope lines (or dotplot arrows). Default 1 (black).

base_size

Base font size, to be passed to theme style when plot_style = "ggplot2".

labels

A character vector of suitable length. If dotplot = TRUE, then labels for the tests at x-axis. Labels for the separate plots, ignored if separate_yaxes is FALSE.

add

Whether to add the plot to an existing plot (TRUE) or to draw a new plot (FALSE). Not available for plot_style = "ggplot2".

digits

The number of digits used for printing the p-value or p-interval in the main, if using the default main.

level

1 or 2. In the case of combined tests (with several test functions), two different plots are available: 1 for plotting the combined global envelopes (default and most often wanted) or 2 for plotting the second level test result.

separate_yaxes

Logical (default FALSE). If TRUE, then separate y-axes are used for different parts of a combined test. If FALSE, then the components are displayed one next to each other with a joint y-axis.

max_ncols_of_plots

If separate_yaxes is TRUE, then max_ncols_of_plots gives the maximum number of columns for figures. Default 2. Relevant only for combined tests with several test functions.

nticks

The number of ticks on the xaxis. Relevant only for combined tests with separate_yaxes = TRUE.

...

Additional parameters to be passed to plot or lines.

See Also

central_region


myllym/GET documentation built on Dec. 23, 2018, 1:04 p.m.