| PlotDisparity {aides} | R Documentation |
Illustrate disparity plot.
Description
PlotDisparity() is a function for illustrating graphics of disparities in sample size analysis.
Usage
PlotDisparity(
object,
which = NULL,
lgcTtl = TRUE,
lgcTtlX = TRUE,
lgcTtlY = TRUE,
lgcLgnd = TRUE,
lgcDtls = FALSE,
lgcLblZn = TRUE,
txtLbl = NULL,
szFntTtl = NULL,
szFntTtlX = NULL,
szFntTtlY = NULL,
szFntAxsX = NULL,
szFntEC = NULL,
szFntAxsY = NULL,
szFntLgnd = NULL,
szFntLbl = NULL,
szFntLblEC = NULL,
szPnt = NULL,
szPntEC = NULL,
szPntNEC = NULL,
typPltCV = NULL,
typPnt = NULL,
typPntEC = NULL,
typPntNEC = NULL,
typLn0 = NULL,
typLnEC = NULL,
clrTtl = NULL,
clrTtlX = NULL,
clrTtlY = NULL,
clrAxsX = NULL,
clrAxsY = NULL,
clrLgnd = NULL,
clrVrtnL = NULL,
clrVrtnM = NULL,
clrVrtnH = NULL,
clrLblZn = NULL,
clrLbl = NULL,
clrLblEC = NULL,
clrPnt = NULL,
clrPntEC = NULL,
clrPntNEC = NULL,
clrLn0 = NULL,
clrLnEC = NULL,
clrLnCV = NULL,
anglAxsX = NULL,
anglLbl = NULL,
sort = NULL
)
Arguments
object |
OBJECT of the disparity test output in disparity class. |
which |
CHARACTER for indicating type of disparity plot. Current version consists of five plots, including disparity plot of variability and outliers based on: (1) coefficient of variance ("CV"), (2) IQR-outlier ("IQR"), (3) Z-outlier ("Z"), (4) GESD-outlier ("GESD"), (5) MAD-outlier ("MAD"). |
lgcTtl |
LOGIC value for indicating whether to show main title. |
lgcTtlX |
LOGIC value for indicating whether to show title on axis X. |
lgcTtlY |
LOGIC value for indicating whether to show title on axis Y. |
lgcLgnd |
LOGIC value for indicating whether to show legend. |
lgcDtls |
LOGIC value for indicating whether to show full information of the disparity test rather than plot-related information. |
lgcLblZn |
LOGIC value for indicating whether to show labels of variability zone. |
txtLbl |
CHARACTER for indicating numeric information of each study disparity plot (outlier). Current version provides options for no label (NULL), numbers of cases ("n"), numbers of excessive cases ("n.excessive"), and proportion of excessive cases ("prop.excessive"). |
szFntTtl |
NUMERIC value for indicating font size of main title. |
szFntTtlX |
NUMERIC value for indicating font size of title on axis X. |
szFntTtlY |
NUMERIC value for indicating font size of title on axis Y. |
szFntAxsX |
NUMERIC value(s) for indicating font size of study label(s). |
szFntEC |
NUMERIC value(s) for indicating font size of study label(s) for those studies with excessive case. |
szFntAxsY |
NUMERIC value for indicating font size of scale on axis Y. |
szFntLgnd |
NUMERIC value for indicating font size of legend. |
szFntLbl |
NUMERIC value(s) for indicating font size of label(s) for observed value(s). |
szFntLblEC |
NUMERIC value(s) for indicating font size of label(s) for observed value(s) with excessive case. |
szPnt |
NUMERIC value(s) for indicating size(s) of observed point(s). |
szPntEC |
NUMERIC value for indicating size of observed point(s) with excessive cases. |
szPntNEC |
NUMERIC value for indicating size of observed point(s) without excessive cases. |
typPltCV |
CHARACTER for indicating sub-type of disparity plot for showing variability. Current version provides two sub-types: "half" and "full" plot. |
typPnt |
NUMERIC value(s) for indicating type(s) of observed point(s). |
typPntEC |
NUMERIC value for indicating type of observed point(s). with excessive cases. |
typPntNEC |
NUMERIC value for indicating type of observed point(s). without excessive cases. |
typLn0 |
NUMERIC value for indicating type of horizontal line for no excessive case. |
typLnEC |
NUMERIC value for indicating type of vertical line(s) for excessive case(s). |
clrTtl |
CHARACTER of a color name for main title. |
clrTtlX |
CHARACTER of a color name for title on axis X. |
clrTtlY |
CHARACTER of a color name for title on axis Y. |
clrAxsX |
CHARACTER of color name(s) for study label. |
clrAxsY |
CHARACTER of a color name for scale on axis Y. |
clrLgnd |
CHARACTER of a color name for legend. |
clrVrtnL |
CHARACTER of a color name for low variability zone. |
clrVrtnM |
CHARACTER of a color name for moderate variability zone. |
clrVrtnH |
CHARACTER of a color name for high variability zone. |
clrLblZn |
CHARACTER of color name(s) for variability zone(s). |
clrLbl |
CHARACTER of color name(s) for observed value(s). |
clrLblEC |
CHARACTER of color name(s) for observed value(s) of studies with excessive cases. |
clrPnt |
CHARACTER of color name(s) for every observed point. |
clrPntEC |
CHARACTER of a color name for proportion of excessive cases. |
clrPntNEC |
CHARACTER of a color name for observed point without excessive case. |
clrLn0 |
CHARACTER of a color name for horizontal line of no excessive case. |
clrLnEC |
CHARACTER of color name for vertical line(s) of excessive case(s). |
clrLnCV |
CHARACTER of color name for line of the association between standard deviation and cases. |
anglAxsX |
NUMERIC value between 0 and 360 for indicating angle of study labels on x axis on the disparity plot (outlier). |
anglLbl |
NUMERIC value between 0 and 360 for indicating angle of observed values on the disparity plot (outlier). |
sort |
CHARACTER of data sorting reference for disparity plot. Currentversion consists of "time", "size", and "excessive" for displaying observations on disparity plot of outlier(s). |
Value
PlotDisparity() returns a disparity plot.
Author(s)
Enoch Kang
References
Shapiro, S. S., & Wilk, M. B. (1965). An analysis of variance test for normality (complete samples). Biometrika, 52(3), 591-611.
Rosner, B. (1983). Percentage Points for a Generalized ESD Many-Outlier Procedure. Technometrics, 25(2), 165-172.
Rousseeuw, P. J. & Croux C. (1993). Alternatives to the Median Absolute Deviation, Journal of the American Statistical Association, 88(424), 1273-1283. http://dx.doi.org/10.1080/01621459.1993.10476408
Hendricks, W. A., & Robey, K. W. (1936). The sampling distribution of the coefficient of variation. The Annals of Mathematical Statistics, 7(3), 129-132.
Sokal, R. R., & Braumann, C. A. (1980). Significance tests for coefficients of variation and variability profiles. Systematic Biology, 29(1), 50-66.