DisplayCoefficients: Display Coefficients

View source: R/DataUnderstanding.R

DisplayCoefficientsR Documentation

Display Coefficients

Description

Displays either coefficients from a named vector or from a lm-model.

Usage

DisplayCoefficients(CoefficientVectorOrlmModel, DisplayIntercept = F)

Arguments

CoefficientVectorOrlmModel

either a named vectoror a lm-model result.

DisplayIntercept

boolean. If TRUE, everytrhing that sounds like 'intercept' will be deleted out of the dataset

Details

If the character vector has no coefficient names, a character vector in form v1...vk (k: number of coefficients in vector) will be built.

Value

data.frame. DataFrame of coefficients with three variables: variablenames, Coefficients, PositiveDirection

Examples

## Mode 1: named vector
# Generate some data
Coefficients <- c(0.5, 0.7, -0.3)
names(Coefficients) <- c("Klarheit", "Freundlichkeit", "Dauer")
## Call function
DisplayCoefficients(CoefficientVectorOrlmModel = Coefficients,
                    DisplayIntercept = F)
## Mode 2: lm model output
# Generate a lm-object:
mtcarsLmComplete <- lm(mpg ~ ., data = mtcars)
## Call function
DisplayCoefficients(CoefficientVectorOrlmModel = mtcarsLmComplete,
                    DisplayIntercept = T)

masem-research/masemDataUnderstanding documentation built on May 5, 2022, 12:40 a.m.