Print and coerce design-effect results

Print and coerce design-effect results

Usage

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

# S3 method for class 'svyplan_design_effect'
format(x, ...)

# S3 method for class 'svyplan_design_effect'
as.double(x, ...)

# S3 method for class 'svyplan_design_effect'
as.data.frame(
  x,
  row.names = NULL,
  optional = FALSE,
  stringsAsFactors = FALSE,
  validRN = TRUE,
  ...
)

# S3 method for class 'svyplan_design_effect'
Ops(e1, e2)

# S3 method for class 'svyplan_design_effect'
Math(x, ...)

Arguments

x

A svyplan_design_effect object.

...

For mathematical transformations, additional arguments passed to the underlying operation. The other methods do not support additional arguments.

row.names, optional

Standard as.data.frame() arguments.

stringsAsFactors

Logical. Retained for compatibility when a result is converted through data.frame().

validRN

Logical. Accepted for compatibility with data.frame() in R 4.7.0 and later. Svyplan results already have valid row names.

e1, e2

Objects supplied to an arithmetic or comparison operator.

Value

print() returns x invisibly, format() returns a character scalar, as.double() returns the overall design effect, and as.data.frame() returns the component table. Arithmetic and mathematical transformations return ordinary numeric results.