get_summary: Summarize a simloglm object
In mneunhoe/simloglm: Simulate Correct Quantities of Interest from Linear Models with Logged Dependent Variables
get_summary R Documentation
Summarize a simloglm object
Description
Summarize a simloglm object
Usage
get_summary(input_obj, which_qoi = "median", alpha = 0.05)
Arguments
input_obj
An object of class simloglm (the output of calling simloglm).
alpha
The significance level for the resulting confidence interval. Default is 0.05.
which_mean
Are you interested in the conditional arithmetic mean ("arithmetic_mean") or conditional geometric mean ("geometric_mean"; same as median)? Default is "geometric_mean".
Examples
df <- cars
regression <- lm(log(dist)~speed, data = df)
# Specifiying no scenario to simulate at the mean of speed.
simulation_results <- simloglm(regression)
simulation_summary <- get_summary(simulation_results)
simulation_summary
mneunhoe/simloglm documentation built on June 14, 2022, 5:18 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| get_summary | R Documentation |
Summarize a simloglm object
Description
Summarize a simloglm object
Usage
get_summary(input_obj, which_qoi = "median", alpha = 0.05)
Arguments
input_obj |
An object of class simloglm (the output of calling simloglm). |
alpha |
The significance level for the resulting confidence interval. Default is 0.05. |
which_mean |
Are you interested in the conditional arithmetic mean ("arithmetic_mean") or conditional geometric mean ("geometric_mean"; same as median)? Default is "geometric_mean". |
Examples
df <- cars regression <- lm(log(dist)~speed, data = df) # Specifiying no scenario to simulate at the mean of speed. simulation_results <- simloglm(regression) simulation_summary <- get_summary(simulation_results) simulation_summary
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.