Skip to contents

Summarize COS Package Objects

cos_summary_methods.Rd

S3 summary() methods for the main objects returned by cosTapered, together with matching print() methods for the returned summary objects. These methods report fuller diagnostics and posterior or prediction summaries than the compact overviews printed by cos_print_methods.

Usage

# S3 method for class 'cos_prep'
summary(object, digits = 3, ...)

# S3 method for class 'summary.cos_prep'
print(x, ...)

# S3 method for class 'cos_recovery_B'
summary(object, probs = c(0.5, 0.025, 0.975),
  digits = 3, include_eta_B = TRUE, ...)

# S3 method for class 'summary.cos_recovery_B'
print(x, ...)

# S3 method for class 'cos_prediction_fine'
summary(object, digits = 3, ...)

# S3 method for class 'summary.cos_prediction_fine'
print(x, ...)

# S3 method for class 'cos_areal_blocks'
summary(object, digits = 3, ...)

# S3 method for class 'summary.cos_areal_blocks'
print(x, ...)

# S3 method for class 'cos_prediction_areal'
summary(object, digits = 3, ...)

# S3 method for class 'summary.cos_prediction_areal'
print(x, ...)

# S3 method for class 'cos_cv_observed'
summary(object, digits = 3, ...)

# S3 method for class 'summary.cos_cv_observed'
print(x, ...)

Arguments

object

A "cos_prep" object from cos_prepare, a "cos_recovery_B" object from cos_recover_B, a "cos_prediction_fine" object from cos_predict_fine, a "cos_areal_blocks" object from cos_make_areal_blocks, a "cos_prediction_areal" object from cos_predict_areal, or a "cos_cv_observed" object from cos_cv_observed, matching the method being dispatched.

x

The matching "summary.*" object returned by one of the summary() methods documented here, for use by the corresponding print() method.

digits

Number of digits used when rounding numeric summaries.

probs

Quantile probabilities used for the beta and observed-support effect summaries in summary.cos_recovery_B().

include_eta_B

Logical; if TRUE, summary.cos_recovery_B() also summarizes recovered observed-support latent means eta_B.

...

Additional arguments passed to methods. Currently unused.

Value

Each summary() method documented here returns a list with class "summary.<x>" matching the input object's class, and each matching print() method prints a compact overview and invisibly returns its input.

  • summary.cos_prep() returns n_B, n_A, p, x_names, spatial, gamma, taper_code, missing, and row_sum_summary.

  • summary.cos_recovery_B() returns n_samples, n_B, spatial, beta_summary, and omega_B_summary. When include_eta_B = TRUE, it also returns eta_B_summary.

  • summary.cos_prediction_fine() returns spatial_uncertainty, uncertainty, target, n_pred, n_samples, keep_samples, spatial, rounded five-number summaries for eta and omega means and standard deviations, and the full prediction_summary data frame. When target = "observed", it also returns rounded five-number summaries for y.

  • summary.cos_areal_blocks() returns n_U, x_names, missing, row_sum_summary, and n_cell_summary.

  • summary.cos_prediction_areal() returns the same fields as summary.cos_prediction_fine(), describing areal prediction units in place of fine prediction cells, plus row_sum_summary and n_U in place of n_pred.

  • summary.cos_cv_observed() returns k, target, spatial, n, and rounded summary, fold_summary, and predictions data frames.

Examples

if (FALSE) { # \dontrun{
summary(prep)
summary(rec_B, include_eta_B = TRUE)
summary(pred)
summary(U_blocks)
summary(pred_U)
summary(cv)
} # }