plot.hadam: Wrapper to ggplot Hadamard Variance Graph

Description Usage Arguments Value Note Author(s) Examples

View source: R/hadam.R

Description

Displays a plot containing the Hadamard variance

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## S3 method for class 'hadam'
plot(x, CI = F, transparence = 0.1,
  background = "white", bw = F, CI.color = "#003C7D",
  line.type = NULL, line.color = NULL, point.size = NULL,
  point.shape = NULL, title = NULL, title.size = 15,
  axis.label.size = 13, axis.tick.size = 11,
  axis.x.label = expression("Cluster " ~ tau ~ "(sec)"),
  axis.y.label = expression("Hadamard Variance " ~ phi[tau]),
  legend.title = "", legend.label = NULL, legend.key.size = 1,
  legend.title.size = 13, legend.text.size = 13, ...)

Arguments

x

A hadam object.

CI

A boolean that indicates whether the confidence interval should be plotted.

transparence

A double that ranges from 0 to 1 that controls the transparency of the graph.

background

A string that determines the graph background. It can be 'grey' or 'white'.

bw

A boolean that indicates whether the graph should be black and white color scheme.

CI.color

A string that indicates the color of the confidence interval (e.g. black, red, #003C7D, etc.)

line.type

A vector of string that indicates the type of lines.

line.color

A vector of string that indicates the color of lines.

point.size

A vector of integer that indicates the size of points on lines.

point.shape

A vector of integer that indicates the shape of points on lines.

title

A string that indicates the title of the graph.

title.size

An integer that indicates the size of title.

axis.label.size

An integer that indicates the size of label.

axis.tick.size

An integer that indicates the size of tick mark.

axis.x.label

A string that indicates the label on x axis.

axis.y.label

A string that indicates the label on y axis.

legend.title

A string that indicates the title of legend.

legend.label

A vector of string that indicates the labels on legend.

legend.key.size

A double that indicates the size of key (in centermeters) on legend.

legend.title.size

An integer that indicates the size of title on legend.

legend.text.size

An integer that indicates the size of key label on legend.

...

other arguments passed to specific methods.

Value

A ggplot2 graph containing the Hadamard variance.

Note

It is known that the calculation for confidence interval is incorrect, therefore CI can only be set to FALSE currently.

Author(s)

JJB, Wenchao

Examples

1
2
3
4
set.seed(999)
x = rnorm(100)
out = hadam(x)
plot( out )

SMAC-Group/gmwm documentation built on Sept. 11, 2021, 10:06 a.m.