test.params: Test Parameters

In akiva-yonah-meiselman/clubsoda: What the Package Does (One Line, Title Case)

Test Parameters

Description

This function tests the validity of several basic model parameters.

Usage

test.params(
  data,
  x.names,
  cluster.id,
  weights = NULL,
  c0 = NULL,
  test.var = NULL,
  fe.id = cluster.id,
  calling.function = "unknown"
)

Arguments

data	Data frame or matrix containing all outcomes, covariates, and group ids
x.names	Vector of covariate names
cluster.id	Name of cluster id variable
weights	Name of weight variable, if applicable
c0	Linear hypothesis vector, either c0 or test.var must be supplied
test.var	Index of variable to test, either c0 or test.var must be supplied
fe.id	Name of fixed effect group id variable (defaults to cluster.id)
calling.function	Function whose parameters are being checked

Value

TRUE if no errors, otherwise does not return

akiva-yonah-meiselman/clubsoda documentation built on Feb. 3, 2025, 1:34 p.m.