summary.cartogramR {cartogramR}

Summary of a cartogram object

Description

Summary of a cartogram object

Usage

## S3 method for class 'cartogramR'
summary(object, ...)

Arguments

object

a cartogramR object

...

arguments passed to or from other methods. The following arguments are available: - digits integer, used for number formatting with signif if not specified (i.e., ⁠[missing](.)⁠, ⁠[signif]()⁠ will not be called anymore (since \R >= 3.4.0, where the default has been changed to only round in the print and format methods). - quantile.type integer code used in ⁠quantile(*, type=quantile.type)⁠. - center character string code used in residuals.cartogramR. - initial_data; the initial sf object given as input of cartogramR. Only needed for symmetric differences residuals.

Value

A summary.cartogramR object: a list with the following components:

• qrr, the summary of absolute relative residuals

• qres, the summary of absolute residuals

• qsymdiff, the summary of all pairwise symmetric difference beween two scaled (multi)polygons representative of two regions. These residuals are calculated only if initial_data argument is provided.

Examples

  data(usa)
  carto <- cartogramR(usa, "electors64")
  summary(carto)