params: generic call for reporting the parameter estiamtes from...

Usage Arguments

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
params(fit, alpha = getOption("qwraps.alpha", 0.05), ...)

## S3 method for class 'coxph'
params(fit, alpha = getOption("qwraps.alpha", 0.05), ...)

## S3 method for class 'glm'
params(fit, alpha = getOption("qwraps.alpha", 0.05), ...)

## S3 method for class 'lm'
params(fit, alpha = getOption("qwraps.alpha", 0.05), ...)

## S3 method for class 'survfit'
params(fit, alpha = getOption("qwraps.alpha", 0.05), ...)

Arguments

fit

a lm, glm, coxph, or survfit object

alpha

significance level, 100(1-alpha)

\item

...arguments to pass to params_frmtr as noted in the following

\item

paramif NULL (default) then a full matrix of of all coeffients will be returned. A character represtation of the parameters of interest can be returned if specified.

\item

digitsnumber of digits after the decimal point, included trailing zeros, to print numbers to: see frmt

\item

pdigitsnumber of digits to format p-values: see frmtp

\item

show.cilogical, return confidence intervals

\item

show.pvallogical, return the p-values

\item

alphasignificant level, reporting 100(1-alpha)

\item

funfunciton for transforming results. Particularly useful is fun = exp when working with logisitic regression models, for example.

\item

show.equal.signpassed to frmtp

\item

unitcan be added to the strings returned such that the string could be xx mg (95 xx (95

\item

big.markpassed to frmt

\item

small.markpassed to frmt Parameter estiamtes, confidence intervals, and p-values form regression models. Results are presented in three forms, numeric matrix, character matrix, and individual strings. The character matrix and strings are intended to be used when knitting with LaTeX. fit <- lm(mpg ~ wt + cyl, data = mtcars) params(fit) params(fit, param = "wt")

## logisitic regression fit <- glm(I(mgp > 25) ~ wt + cyl, data = mtcars, family = binomial(link = "logit")) # log odds params(fit) # odds ratios params(fit, fun = exp) Peter DeWitt params_frmtr regression results


dewittpe/qwraps documentation built on May 15, 2019, 5:07 a.m.