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

View source: R/envelopes.r

plot.combined_global_envelopeR Documentation

Plot method for the class 'combined_global_envelope'

Description

This function provides plots for combined global envelopes.

Usage

## S3 method for class 'combined_global_envelope'
plot(
  x,
  labels,
  scales,
  sign.col = "red",
  dotplot = length(x[[1]]$obs) < 5,
  ncol = 2 + 1 * (length(x) == 3),
  digits = 3,
  level = 1,
  ...
)

Arguments

x

An 'combined_global_envelope' object

labels

A character vector of suitable length. If dotplot = TRUE (for the level 2 test), then labels for the tests at x-axis; only valid/used when all components of x have the same dimension. Otherwise labels for the separate plots.

scales

See facet_wrap. Use scales = "free" when the scales of the functions in the global envelope vary. scales = "fixed" is a good choice, when you want the same y-axis for all components. A sensible default based on r-values exists.

sign.col

The color for the observed curve when outside the global envelope (significant regions). Default to "red". Setting the color to NULL corresponds to no coloring. If the object contains several envelopes, the coloring is done for the widest one.

dotplot

Logical. If TRUE, then instead of envelopes a dot plot is done. Suitable for low dimensional test vectors.

ncol

The maximum number of columns for the figures. Default 2 or 3, if the length of x equals 3. (Relates to the number of curve_sets that have been combined.)

digits

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

level

1 or 2. In the case of two-step 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.

...

Ignored in most cases. If dotplot = TRUE, then parameters can be passed to arrow, e.g. length = unit(0.25, "cm").

Details

Plotting method for the class 'combined_global_envelope', i.e. combined envelopes for 1d functions.

See Also

central_region


GET documentation built on Sept. 11, 2024, 5:46 p.m.