knitr::opts_chunk$set( collapse = TRUE, comment = "#>", fig.path = "man/figures/README-", fig.align = "center", fig.height = 4.5, fig.width = 6.5, out.width = "85%", dpi = 200 ) options(width = 100)
rsimsum
is an R package that can compute summary statistics from simulation studies. rsimsum
is modelled upon a similar package available in Stata, the user-written command simsum
(White I.R., 2010).
The aim of rsimsum
is to help to report simulation studies, including understanding the role of chance in results of simulation studies: Monte Carlo standard errors and confidence intervals based on them are computed and presented to the user by default. rsimsum
can compute a wide variety of summary statistics: bias, empirical and model-based standard errors, relative precision, relative error in model standard error, mean squared error, coverage, bias. Further details on each summary statistic are presented elsewhere (White I.R., 2010; Morris et al, 2019).
The main function of rsimsum
is called simsum
and can handle simulation studies with a single estimand of interest at a time. Missing values are excluded by default, and it is possible to define boundary values to drop estimated values or standard errors exceeding such limits. It is possible to define a variable representing methods compared with the simulation study, and it is possible to define by factors, that is, factors that vary between the different simulated scenarios (data-generating mechanisms, DGMs). However, methods and DGMs are not strictly required: in that case, a simulation study with a single scenario and a single method is assumed. Finally, rsimsum
provides a function named multisimsum
that allows summarising simulation studies with multiple estimands as well.
An important step of reporting a simulation study consists in visualising the results; therefore, rsimsum
exploits the R package ggplot2
to produce a portfolio of opinionated data visualisations for quick exploration of results, inferring colours and facetting by data-generating mechanisms. rsimsum
includes methods to produce (1) plots of summary statistics with confidence intervals based on Monte Carlo standard errors (forest plots, lolly plots), (2) zipper plots to graphically visualise coverage by directly plotting confidence intervals, (3) plots for method-wise comparisons of estimates and standard errors (scatter plots, Bland-Altman plots, ridgeline plots), and (4) heat plots. The latter is a visualisation type that has not been traditionally used to present results of simulation studies, and consists in a mosaic plot where the factor on the x-axis is the methods compared with the current simulation study and the factor on the y-axis is the data-generating factors. Each tile of the mosaic plot is coloured according to the value of the summary statistic of interest, with a red colour representing values above the target value and a blue colour representing values below the target.
You can install rsimsum
from CRAN:
install.packages("rsimsum")
Alternatively, it is possible to install the development version from GitHub using the remotes
package:
# install.packages("remotes") remotes::install_github("ellessenne/rsimsum")
This is a basic example using data from a simulation study on missing data (type help("MIsim", package = "rsimsum")
in the R console for more information):
library(rsimsum) data("MIsim", package = "rsimsum") s <- simsum(data = MIsim, estvarname = "b", true = 0.5, se = "se", methodvar = "method", x = TRUE) s
We set x = TRUE
as it will be required for some plot types.
Summarising the results:
summary(s)
rsimsum
comes with 5 vignettes. In particular, check out the introductory one:
vignette(topic = "A-introduction", package = "rsimsum")
The list of vignettes could be obtained by typing the following in the R console:
vignette(package = "rsimsum")
As of version 0.2.0
, rsimsum
can produce a variety of plots: among others, lolly plots, forest plots, zipper plots, etc.:
library(ggplot2) autoplot(s, type = "lolly", stats = "bias")
autoplot(s, type = "zip")
With rsimsum
0.5.0
the plotting functionality has been completely rewritten, and new plot types have been implemented:
autoplot(s, type = "est_ba")
autoplot(s, type = "est_ridge")
Nested loop plots have been implemented in rsimsum
0.6.0
:
data("nlp", package = "rsimsum") s.nlp <- rsimsum::simsum( data = nlp, estvarname = "b", true = 0, se = "se", methodvar = "model", by = c("baseline", "ss", "esigma") ) autoplot(s.nlp, stats = "bias", type = "nlp")
Finally, as of rsimsum
0.7.1
contour plots and hexbin plots have been implemented as well:
autoplot(s, type = "est_density")
autoplot(s, type = "est_hex")
They provide a useful alternative when there are several data points with large overlap (e.g. in a scatterplot).
The plotting functionality now extend the S3 generic autoplot
: see ?ggplot2::autoplot
and ?rsimsum::autoplot.simsum
for further details.
More details and information can be found in the vignettes dedicated to plotting:
vignette(topic = "C-plotting", package = "rsimsum") vignette(topic = "D-nlp", package = "rsimsum")
If you find rsimsum
useful, please cite it in your publications:
citation("rsimsum")
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.