sigplot: A HDECO internal plot tool for identifying G-squared...

Description Usage Arguments Value Author(s) Examples

Description

Adds shaded points to decomposition spectra to identify decomposition steps with significant G-squared2 statistic values. Requires the output from t.hdeco, specifically the object titled .HPROFIL. This function is called internally by t.hdeco, but can be used independently if the .HPROFIL object exists.

Usage

1
sigplot(mat = .HPROFIL, column = 5, sigcol = 7, tit = "Title of Graph", xtit = "Step", ytit = "Uncertainty Coefficient", override = FALSE, lowy = 0, highy = 1)

Arguments

mat

The required .HPROFIL matrix output by the t.hdeco function (or a comparable matrix object).

column

Identifies the column (integer) with the data to be plotted (e.g., 5 is the uncertainty coefficient - UNC).

sigcol

Identifies the column (integer) with the significance value for the G-squared statistic.

tit

A text string identifying the title for the plot.

xtit

A text string used for the x-axis label.

ytit

A text string used for the y-axis label.

override

Boolean flag to override the minimum and maximum y-axis values.

lowy

If override is TRUE, then the new low y-axis value.

highy

If override is TRUE, then the new high y-axis value.

Value

The graphical result is provided in the graphics window.

Author(s)

Tarmo K. Remmel

Examples

1
2
data(HPROFIL)
sigplot(mat = HPROFIL, column = 5, sigcol = 7, tit = "Title of Graph", xtit = "Step", ytit = "Uncertainty Coefficient", override = FALSE, lowy = 0, highy = 1)

hdeco documentation built on May 30, 2017, 8:26 a.m.