LogisticRegression: Logistic regression

Description Usage Arguments

View source: R/LogisticRegression.R

Description

Runs a logistic regression.

Usage

1
2
3
4
5
6
LogisticRegression(study.sample, outcome.name, covariate.names,
  run.bivariable.analyses = FALSE, stop.if.missing = TRUE,
  create.table = TRUE, table.options = list(odds.ratio = TRUE,
  confidence.interval = 0.95, include.p.value = FALSE, digits = 2,
  save.table = TRUE, table.name = NULL, verbose = FALSE),
  verbose = FALSE)

Arguments

study.sample

Data frame. The study sample. No default.

outcome.name

Character vector of length 1. The name of the outcome variable. No default.

covariate.names

Character vector. The names of the covariates. No default.

run.bivariable.analyses

Logical vector of length 1. If TRUE bivariable analyses are run before the full model is run and these results are included in the final table as unadjusted estimates. Defaults to FALSE.

stop.if.missing

Logical vector of length 1. If TRUE the execution stops if there is missing data in the outcome or covariates. Defaults to TRUE.

create.table

Logical vector of length 1. If TRUE a table with the regression results is created and returned. The apperance of this table can be modified using table.options. If FALSE the model object is returned. Defaults to TRUE.

table.options

List. Can only include "odds.ratio", "confidence.interval", "include.intercept", "include.p.value", "digits", "save.table", "table.name", and "verbose". See ?CreateLogisticRegressionTable for details.

verbose

Logical vector of length 1. If TRUE progress is printed as the function runs. Useful for debugging. Defaults to FALSE.


martingerdin/bengaltiger documentation built on Feb. 29, 2020, 4:46 p.m.