updated simulations vignette

Author: jhelvy

NEWS.md

@@ -4,6 +4,7 @@
 ## Summary of larger updates:
 
 - Added support for auto creating interactions amongst variables
+- exported `getCoefTable()` function
 
 ## Summary of smaller updates:
 

README.Rmd

@@ -10,12 +10,12 @@ knitr::opts_chunk$set(
   warning    = FALSE,
   message    = FALSE,
   comment    = "#>",
-  fig.path   = "man/figures/",
+  fig.path   = "man/figs/",
   fig.retina = 3
 )
 ```
 
-# logitr <a href='https://jhelvy.github.io/logitr/'><img src='man/figures/logitr-hex.png' align="right" height="139" /></a>
+# logitr <a href='https://jhelvy.github.io/logitr/'><img src='man/figs/logitr-hex.png' align="right" height="139" /></a>
 
 <!-- badges: start -->
 [![Lifecycle:

README.md

@@ -1,7 +1,7 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
-# logitr <a href='https://jhelvy.github.io/logitr/'><img src='man/figures/logitr-hex.png' align="right" height="139" /></a>
+# logitr <a href='https://jhelvy.github.io/logitr/'><img src='man/figs/logitr-hex.png' align="right" height="139" /></a>
 
 <!-- badges: start -->
 
@@ -88,16 +88,16 @@ citation("logitr")
 #> 
 #> To cite logitr in publications use:
 #> 
-#>   John Paul Helveston. logitr: Random utility logit models with
-#>   preference and willingness to pay space parameterizations (2020)
+#>   John Paul Helveston (2020). logitr: Random utility logit models with
+#>   preference and willingness to pay space parameterizations.
 #> 
 #> A BibTeX entry for LaTeX users is
 #> 
 #>   @Manual{,
 #>     title = {logitr: Random utility logit models with preference and willingness to pay space parameterizations},
 #>     author = {John Paul Helveston},
 #>     year = {2020},
-#>     note = {R package version 0.0.4},
+#>     note = {R package version 0.0.5},
 #>     url = {https://jhelvy.github.io/logitr/},
 #>   }
 ```

_pkgdown.yml

@@ -54,6 +54,7 @@ reference:
   contents:
   - summary.logitr
   - coef.logitr
+  - getCoefTable
   - statusCodes
 - title: "Computing and Comparing WTP"
   desc: "Functions for computing and comparing WTP from estimated models."

inst/example/simulations.R

@@ -49,16 +49,6 @@ sim_mxl_pref
 sim_mxl_wtp <- simulateShares(mxl_wtp, alts, priceName = 'price')
 sim_mxl_wtp
 
-# Plot simulation results from preference space MNL model:
-library(ggplot2)
-sim_mnl_pref$alt <- row.names(sim_mnl_pref)
-ggplot(sim_mnl_pref, aes(x = alt, y = share_mean)) +
-    geom_bar(stat = 'identity', width = 0.7, fill = "dodgerblue") +
-    geom_errorbar(aes(ymin = share_low, ymax = share_high), width = 0.2) +
-    scale_y_continuous(limits = c(0, 1)) +
-    labs(x = 'Alternative', y = 'Expected Share') +
-    theme_bw()
-
 # Save results
 saveRDS(sim_mnl_pref,
         here::here('inst', 'extdata', 'sim_mnl_pref.Rds'))
@@ -68,3 +58,19 @@ saveRDS(sim_mxl_pref,
         here::here('inst', 'extdata', 'sim_mxl_pref.Rds'))
 saveRDS(sim_mxl_wtp,
         here::here('inst', 'extdata', 'sim_mxl_wtp.Rds'))
+
+# Plot simulation results from each model:
+library(ggplot2)
+
+sims <- rbind(sim_mnl_pref, sim_mnl_wtp, sim_mxl_pref, sim_mxl_wtp)
+sims$model <- c(rep("mnl_pref", 4), rep("mnl_wtp", 4),
+                rep("mxl_pref", 4), rep("mxl_wtp", 4))
+sims$alt <- rep(row.names(alts), 4)
+
+ggplot(sims, aes(x = alt, y = share_mean, fill = model)) +
+    geom_bar(stat = 'identity', width = 0.7, position = "dodge") +
+    geom_errorbar(aes(ymin = share_low, ymax = share_high),
+                  width = 0.2, position = position_dodge(width = 0.7)) +
+    scale_y_continuous(limits = c(0, 1)) +
+    labs(x = 'Alternative', y = 'Expected Share') +
+    theme_bw()