scaleboot Home Page

scaleboot: Approximately Unbiased P-values via Multiscale Bootstrap


Contact

Hidetoshi Shimodaira
Graduate School of Informatics
Kyoto University
Jointly affiliated at RIKEN AIP
Lab website

What is scaleboot?

scaleboot is an add-on package of R. This is for calculating approximately unbiased (AU) p-values from a set of multiscale bootstrap probabilities for a hypothesis. Scaling is equivalent to changing the sample size of data set in bootstrap resampling. We calculate bootstrap probabilities at several scales, from which a very accurate p-value is calculated. This multiscale bootstrap method has been implemented in CONSEL software and pvclust package. The thrust of scaleboot package is to calculate an improved version of AU p-values which are justified even for hypotheses with nonsmooth boundaries by taking care of the singularity.

scaleboot package includes an interface to pvclust package of R for bootstrapping hierarchical clustering. We use pvclust to calculate multiscale bootstrap probabilities, from which we calculate an improved version of AU p-values using scaleboot.

scaleboot has a front end for phylogenetic inference, and it can replace CONSEL software for testing phylogenetic trees. Currently, scaleboot does not have a method for file conversion of several phylogenetic software, and so we must use CONSEL for this purpose before applying scaleboot to calculate an improved version of AU p-values for trees and edges.

The package vignette "Multiscale Bootstrap Using Scaleboot Package" (usesb.pdf) explains the methodology. It includes a simple example for illustration. It also includes real applications in hierarchical clustering and phylogenetic inference. Further description is given in Shimodaira (2008). For the use of scaleboot, Shimodaira (2008) may be referenced.

New in 2019. A new method "Selective Infernce" (SI) has been implemented in scaleboot (>=1.0-0) and pvclust (>=2.1-0); currently they are only in the development versions available at github sites. SI is useful for computing p-values for edges (or clusters). The method is explained in Shimodaira and Terada (2019), and it may be cited for using SI value. The theory of SI is described in Terada and Shimodaira (2017). Three new vignettes are also available: "Phylogenetic Tree Selection" (phylo.pdf), "Model Map in Phylogenetics" (modelmap.pdf), "Computing selective inference p-values of clusters using pvclust and scaleboot" (pvclust.pdf).


Hosts

The stable version of scaleboot as well as pvclust is available at CRAN. The development version of scaleboot as well as pvclust is available at github.

Install

scaleboot as well as pvclust is easily installed from CRAN online. RStudio users can install the package by choosing "scaleboot" from the pull-down menu. Otherwise, run R on your computer and type

> install.packages("scaleboot")
> install.packages("pvclust")

The development version of scaleboot as well as pvclust is installed from github. You need the devtools for installing from github.

> install.packages("devtools") # binary version is ok
> library(devtools)
> install_github("shimo-lab/scaleboot", subdir = "src") # ref=master
> install_github("shimo-lab/pvclust", ref = "develop", subdir = "src")

Dataset files

Supplementary dataset files for phylogenetic inference are available at dataset/mam15-files directory of the github site.

References