breg {bregr}R Documentation

Creates a new breg-class object

Description

[Stable]

Constructs a breg-class object containing regression model specifications and results.

Usage

breg(
  data = NULL,
  y = NULL,
  x = NULL,
  x2 = NULL,
  group_by = NULL,
  config = NULL,
  models = list(),
  results = NULL,
  results_tidy = NULL
)

Arguments

data

A data.frame containing modeling data.

y

Character vector of dependent variable names.

x

Character vector of focal independent variable names.

x2

Optional character vector of control variable names.

group_by

Optional character vector specifying grouping column.

config

List of model configuration parameters.

models

List containing fitted model objects.

results

A data.frame of model results from broom.helpers::tidy_plus_plus().

results_tidy

A data.frame of tidy model results from broom::tidy().

Value

A constructed breg object.

Examples

obj <- breg()
obj
print(obj, raw = TRUE)


[Package bregr version 1.0.0 Index]