StudySpecification_summary: Summarizing 'StudySpecification' objects

summary.StudySpecificationR Documentation

Summarizing StudySpecification objects

Description

summary() method for class StudySpecification.

Usage

## S3 method for class 'StudySpecification'
summary(object, ..., treatment_binary = TRUE)

## S3 method for class 'summary.StudySpecification'
print(x, ..., max_unit_print = 3)

Arguments

object

StudySpecification object, usually a result of a call to rct_spec(), obs_spec(), or rd_spec().

...

Ignored

treatment_binary

Should the treatment be dichotomized if object contains a dichotomy? Ignored if object does not contain a dichotomy.

x

summary.StudySpecification object, usually as a result of a call to summary.StudySpecification()

max_unit_print

Maximum number of treatment levels to print in treatment table

Value

The StudySpecification or summary.StudySpecificationobject, invisibly


propertee documentation built on Aug. 22, 2025, 1:09 a.m.