README.md

StrapvizR

R-CMD-check codecov

Summary

Performs bootstrapping of a sample to produce plots and statistics for use in final reports and documents.

The purpose of this package is to simplify and automate the process of creating simple bootstrap distributions of numerical samples. The package has a module which intakes a sample and relevant parameters such as the desired confidence bounds and number of simulations. The module will perform the simulation statistics to generate the bootstrap distribution and relevant statistics such as the sample mean and bootstrapped confidence interval. The package also has a module for visualization of the bootstrapped confidence interval, and for creating a professional publication-ready table of the relevant statistics.

Package context within the R ecosystem

The package builds on the dplyr package and the ggplot2 package to achieve the above mentioned functionalities. The BootCI package seems to streamline the confidence interval process but does not include plotting support. StrapvizR streamlines the process of bootstrapping from data to visualization and embedding in documents which is not available as a single bundle. Some tutorials on bootstrap confidence intervals at sources (1), (2) and (3) encourage the reader to plot the results manually.

Installation

You can install the latest version of strapvizr from GitHub

# install.packages("devtools")
devtools::install_github("UBC-MDS/strapvizr")

Usage

To import the strapvizr package

library(strapvizr)

Please find the detailed documentation here.

Functions

Contributing

Julien Gordon, Gautham Pughazhendhi, Zack Tang, and Margot Vore.

License

`StrapvizR` was created by Julien Gordon, Gautham Pughazhendhi, Zack Tang, Margot Vore. It is licensed under the terms of the MIT license.



UBC-MDS/strapvizr documentation built on March 22, 2022, 6:39 p.m.