README.md

In UBC-MDS/rfer: Rewriting of `infer` package for practice purposes

Rfer

The rfer package streamlines the process of reshuffling and bootstrapping of samples, calculating summary statistics and confidence intervals that assist in performing statistical inference. It does this using a combination of functions that are built with the emphasis on clear expressive code and using correct statistical grammar that explains the way the values are calculated and how the tests are evaluated in the process of inference.

With this package as the inspiration, rfer will have four main functions (specify,generate,calculate,get_ci) for the first iteration. These functions will, given a data frame and the specified response variable; calculate summary statistics and confidence intervals for the response variable. Further details follow in the description of the functions.

Team

|Group Member |Github | |-|-| |Gabriel Bogo|@GabrielBogo| |Yuwei Liu |@liuyuwei169| |Weifeng (Davy) Guo |@DavyGuo| |Mohamad Makkaoui |@makka3|

Installation instructions

1. To download (requires devtools):

devtools::install_github("UBC-MDS/rfer",build_opts = c("--no-resave-data", "--no-manual"))

1. To load into environment:

library(rfer)

Examples

#Using the iris dataset

iris_width = specify(iris, response="Sepal.Width")
iris_resampled = generate(iris_width, n_samples=30, type="bootstrap")
width_mean = calculate(iris_resampled,column = "Sepal.Width", stat="mean")
width_ci = get_ci(width_mean,column="Sepal.Width",confidence_level=0.9)

#Using the mtcars dataset

mtcars %>%
  specify(response = "hp") %>%
  generate(n_samples = 10,type = "bootstrap") %>%
  calculate(column = "hp",stat="mean") %>%
  get_ci(column = "hp",confidence_level = 0.9, type="percentile")

Coverage

UBC-MDS/rfer documentation built on May 14, 2019, 11:02 p.m.