https://github.com/arpeely/sample-size-calculator

A/B test sample size calculator
https://github.com/arpeely/sample-size-calculator

a-b-testing javascript npm-module typescript

Last synced: 8 months ago
JSON representation

A/B test sample size calculator

• Host: GitHub
• URL: https://github.com/arpeely/sample-size-calculator
• Owner: arpeely
• Created: 2019-07-02T16:02:01.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T03:22:24.000Z (over 3 years ago)
• Last Synced: 2025-02-16T23:02:21.173Z (over 1 year ago)
• Topics: a-b-testing, javascript, npm-module, typescript
• Language: TypeScript
• Size: 699 KB
• Stars: 7
• Watchers: 3
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
Sample Size Calculator


A/B test sample size calculator which uses a two-tailed sequential likelihood ratio test with false discovery rate controls to calculate statistical significance.

[![npm version](https://img.shields.io/npm/v/@arpeely/sample-size-calculator.svg?style=flat-square)](https://www.npmjs.com/package/@arpeely/sample-size-calculator)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

[![volkswagen status](https://auchenberg.github.io/volkswagen/volkswargen_ci.svg?v=1)](https://github.com/auchenberg/volkswagen)

## Credits

This package is inspired by the great work done by [Optimizely's Stats Engine](https://www.optimizely.com).

For the original online version click [here](https://www.optimizely.com/sample-size-calculator/)

## Install

sample-size-calculator is available as an [npm package](https://www.npmjs.com/package/@arpeely/sample-size-calculator).

```sh

#with yarn

yarn add @arpeely/sample-size-calculator

#with npm

npm install @arpeely/sample-size-calculator

```

## Usage

```javascript

import sampleSizeEstimate from '@arpeely/sample-size-calculator'

// The minimum relative change in conversion rate you would like to be able to detect.

const relativeMDE = 0.3 //  30%

// Your control group's expected conversion rate

const baselineConversionRate = 0.3572 //  35.72%

// Sample size per variation

const sampleSize = sampleSizeEstimate(relativeMDE, baselineConversionRate)

console.log(sampleSize) // output: 160

```