summary.linear_fe: Result Summaries of Covariate Estimates from a fitted...

View source: R/summary.linear_fe.R

summary.linear_feR Documentation

Result Summaries of Covariate Estimates from a fitted linear_fe or linear_re object

Description

Provide the summary statistics for the covariate estimates for a fixed/random effect linear model.

Usage

## S3 method for class 'linear_fe'
summary(object, parm, level = 0.95, null = 0, alternative = "two.sided", ...)

## S3 method for class 'linear_re'
summary(object, parm, level = 0.95, null = 0, alternative = "two.sided", ...)

Arguments

object

a model fitted from linear_fe or linear_re.

parm

Specifies a subset of covariates for which the result summaries should be output. By default, all covariates are included.

level

the confidence level during the hypothesis test, meaning a significance level of 1 - \text{level}. The default value is 0.95.

null

a number defining the null hypothesis for the covariate estimates. The default value is 0.

alternative

a character string specifying the alternative hypothesis, must be one of "two.sided" (default), "greater", or "less".

...

additional arguments that can be passed to the function.

Value

A data frame containing summary statistics for covariate estimates, with the following columns:

Estimate

the estimates of covariate coefficients.

Std.Error

the standard error of the estimate.

Stat

the test statistic.

p value

the p-value for the hypothesis test.

CI.upper

the lower bound of the confidence interval.

CI.lower

the upper bound of the confidence interval.

Examples

data(ExampleDataLinear)
outcome <- ExampleDataLinear$Y
covar <- ExampleDataLinear$Z
ID <- ExampleDataLinear$ID
fit_fe <- linear_fe(Y = outcome, Z = covar, ID = ID)
summary(fit_fe)

data(ExampleDataLinear)
outcome <- ExampleDataLinear$Y
covar <- ExampleDataLinear$Z
ID <- ExampleDataLinear$ID
fit_re <- linear_fe(Y = outcome, Z = covar, ID = ID)
summary(fit_re)


pprof documentation built on April 12, 2025, 1:33 a.m.