print_ests: Print parameter estimates

In kinnamon-lab/FamModel: Regression Modeling for Family-Based Genetic Studies

Description

Prints estimates, standard errors, 100(1 - α)% CIs, test statistics, and p-values to the console given a vector of estimates and their covariance matrix. May also specify a function to transform the estimates and 95% CIs. Uses make_coef_mat() for underlying calculations.

Usage

print_ests(theta_hat, V_theta_hat, trans, title = "Parameter Estimates", ...)

Arguments

theta_hat	A named vector of parameter estimates.
V_theta_hat	The covariance matrix of the parameter estimates in theta_hat.
trans	A function accepting a single argument (e.g., exp) that is used to transform parameter estimates and confidence intervals. All tests and standard errors are still on the untransformed scale.
title	A string header to print before the estimates or NULL to not print any header. Defaults to "Parameter Estimates".
...	Arguments passed on to make_coef_mat, stats::printCoefmat alpha The alpha level for the confidence intervals; default 0.05. SEs TRUE (default) if standard errors should be reported. CIs TRUE (default) if 100(1 - α)% CIs should be reported. tests TRUE (default) if Wald test statistics and p-values based on the normal distribution should be reported. digits minimum number of significant digits to be used for most numbers. signif.stars logical; if TRUE, P-values are additionally encoded visually as ‘significance stars’ in order to help scanning of long coefficient tables. It defaults to the show.signif.stars slot of options. signif.legend logical; if TRUE, a legend for the ‘significance stars’ is printed provided signif.stars = TRUE. dig.tst minimum number of significant digits for the test statistics, see tst.ind. zap.ind indices (integer) of column numbers which should be formatted by zapsmall, i.e., by ‘zapping’ values close to 0. P.values logical or NULL; if TRUE, the last column of x is formatted by format.pval as P values. If P.values = NULL, the default, it is set to TRUE only if options("show.coef.Pvalue") is TRUE and x has at least 4 columns and the last column name of x starts with "Pr(". has.Pvalue logical; if TRUE, the last column of x contains P values; in that case, it is printed if and only if P.values (above) is true. eps.Pvalue number, .. na.print a character string to code NA values in printed output. quote further arguments passed to print.default. right further arguments passed to print.default.

kinnamon-lab/FamModel documentation built on April 26, 2021, 4:38 a.m.