dot-check_spec_formula: (Internal) Perform checks on formula for creation of...

.check_spec_formulaR Documentation

(Internal) Perform checks on formula for creation of StudySpecification.

Description

Checks performed:

  • Ensure presence of no more than one of unit_of_assignment(), cluster() or unitid().

  • Disallow multiple block() or multiple forcing() terms.

  • Disallow forcing() unless in RDD.

Usage

.check_spec_formula(form, allow_forcing = FALSE)

Arguments

form

A formula passed to .new_StudySpecification()

allow_forcing

Binary whether forcing() is allowed (TRUE for RDD, FALSE for RCT and Obs).

Value

TRUE if all checks pass, otherwise errors.


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