https://github.com/meikesteinhilber/sprtt

Sequential Probability Ratio Test Toolbox (SPRT)
https://github.com/meikesteinhilber/sprtt

r sequential sprt test-statistic

Last synced: 3 months ago
JSON representation

Sequential Probability Ratio Test Toolbox (SPRT)

• Host: GitHub
• URL: https://github.com/meikesteinhilber/sprtt
• Owner: MeikeSteinhilber
• License: agpl-3.0
• Created: 2021-02-03T12:05:57.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-01-08T20:07:47.000Z (about 1 year ago)
• Last Synced: 2024-09-30T04:05:38.458Z (4 months ago)
• Topics: r, sequential, sprt, test-statistic
• Language: C++
• Homepage: https://meikesteinhilber.github.io/sprtt/
• Size: 45.7 MB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE.md

Awesome Lists containing this project

README

        
---

output: github_document

editor_options:

  markdown:

    mode: gfm

---

```{r setup, include=FALSE}

knitr::opts_chunk$set(

  echo = TRUE,

  collapse = TRUE,

  comment = "#>",

  # fig.path = "man/figures/README-",

  out.width = "100%"

)

options(tibble.print_min = 5, tibble.print_max = 5)

```

# sprtt

[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/sprtt?color=green)](https://cran.r-project.org/package=sprtt)

[![total](https://cranlogs.r-pkg.org/badges/grand-total/sprtt)](https://cran.r-project.org/package=sprtt)

[![monthly](https://cranlogs.r-pkg.org/badges/sprtt)](https://cran.r-project.org/package=sprtt)

[![codecov](https://codecov.io/gh/MeikeSteinhilber/sprtt/branch/main/graph/badge.svg?token=IQHTDTRBAW)](https://app.codecov.io/gh/MeikeSteinhilber/sprtt) [![pkgdown](https://github.com/MeikeSteinhilber/sprtt/actions/workflows/pkgdown-pak.yaml/badge.svg)](https://github.com/MeikeSteinhilber/sprtt/actions/workflows/pkgdown-pak.yaml) [![R-CMD-check](https://github.com/MeikeSteinhilber/sprtt/actions/workflows/R-CMD-check-windows-macOs.yaml/badge.svg)](https://github.com/MeikeSteinhilber/sprtt/actions/workflows/R-CMD-check-windows-macOs.yaml)

## Overview

The `sprtt` package is a **s**equential **p**robability **r**atio **t**ests **t**oolbox (**sprtt**).

The package contains:

-   `seq_ttest()`, `seq_anova()` calculates sequential t-test and sequential one-way ANOVAs

-   three data sets (`df_income`, `df_stress`, `df_cancer`) to run the examples in the t-test documentation

-   `plot_anova()` plots results of sequential ANOVAs

-   `draw_sample_normal()`, `draw_sample_mixture()` simulation of data sets

## Installation

### Release version from CRAN

This is the recommended version for a normal user.

```{r, eval = FALSE}

# installs the package

install.packages("sprtt")

```

### Development version from GitHub

To get a bug fix or to use a feature from the development version, you can install the development version from GitHub.

```{r, eval=FALSE}

# the installation requires the "devtools" package

# install.packages("devtools")

devtools::install_github("MeikeSteinhilber/sprtt")

```

## Documentation

Detailed documentation can be found on the [home page](https://meikesteinhilber.github.io/sprtt/index.html). There are several articles covering the [usage](https://meikesteinhilber.github.io/sprtt/articles/usage-sprtt.html) of the package, the [theoretical background](https://meikesteinhilber.github.io/sprtt/articles/sequential_testing.html) of the test, and also an extended [use case](https://meikesteinhilber.github.io/sprtt/articles/use-case.html).

Short examples can be found in the following paragraph.

### Quick Examples

> **Note**

>

> In the R code sections:

>

> `# comment`: is a comment

>

> `function()`: is R code

>

> `#> results of function()`: is console output

```{r, code=xfun::read_utf8('inst/examples/sprtt_examples.R')}

```