checkPlotSumArgs: Check Arguments Passed to plot.cvCovEst and summary.cvCovEst
In cvCovEst: Cross-Validated Covariance Matrix Estimation

checkPlotSumArgs

R Documentation

Check Arguments Passed to plot.cvCovEst and summary.cvCovEst

Description

The checkPlotSumArgs() function verifies that all arguments passed to the plot.cvCovEst() and summary.cvCovEst() functions meet their specifications. Some additional arguments may be checked at the individual function level.

Usage

checkPlotSumArgs(
  dat,
  dat_orig,
  which_fun,
  estimator,
  plot_type,
  summ_fun,
  stat,
  k,
  leading,
  abs_v
)

Arguments

`dat`	An object of class `"cvCovEst"`. Specifically, this is the standard output of the `cvCovEst()`.
`dat_orig`	The `numeric` `data.frame`, `matrix`, or similar object originally passed to `cvCovEst()`.
`which_fun`	A `character` indicating a choice of `"plot"` or `"summary"` depending on which function is being checked.
`estimator`	A `character` vector specifying one or more classes of estimators to compare.
`plot_type`	A `character` vector specifying one of four choices of diagnostic plots.
`summ_fun`	A `character` vector specifying which summaries to output.
`stat`	A `character` vector of one or more summary statistics to use when comparing estimators.
`k`	A `integer` indicating the number of leading/trailing eigenvalues to plot.
`leading`	A `logical` indicating if the leading eigenvalues should be used.
`abs_v`	A `logical` determining if the absolute value of the matrix entries should be used for plotting the matrix heatmap.