Package: breakaway 5.0.1

breakaway: Species Richness Estimation and Modeling

Understanding the drivers of microbial diversity is an important frontier of microbial ecology, and investigating the diversity of samples from microbial ecosystems is a common step in any microbiome analysis. 'breakaway' is the premier package for statistical analysis of microbial diversity. 'breakaway' implements the latest and greatest estimates of species richness, described in Willis and Bunge (2015) <doi:10.1111/biom.12332>, Willis et al. (2017) <doi:10.1111/rssc.12206>, and Willis (2016) <arxiv:1604.02598>, as well as the most commonly used estimates, including the objective Bayes approach described in Barger and Bunge (2010) <doi:10.1214/10-BA527>.

Authors:Amy D Willis [aut, cre], Bryan D Martin [aut], Pauline Trinh [aut], Sarah Teichman [aut], David Clausen [aut], Kathryn Barger [aut], John Bunge [aut]

breakaway_5.0.1.tar.gz
breakaway_5.0.1.zip(r-4.7)breakaway_5.0.1.zip(r-4.6)breakaway_5.0.1.zip(r-4.5)
breakaway_5.0.1.tgz(r-4.6-any)breakaway_5.0.1.tgz(r-4.5-any)
breakaway_5.0.1.tar.gz(r-4.7-any)breakaway_5.0.1.tar.gz(r-4.6-any)
breakaway_5.0.1.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION
card.svg |card.png
breakaway/json (API)

# Install 'breakaway' in R:
install.packages('breakaway', repos = c('https://adw96.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/adw96/breakaway/issues

Pkgdown/docs site:https://adw96.github.io

Datasets:
  • apples - (Data) Frequency count table of soil microbes in an apples orchard.
  • hawaii - (Data) Frequency count table of soil microbes in Hawaii.
  • pasolli_et_al - (Data) Data frame of covariate information about pasolli_et_al.
  • soil_phylo - (Data) Data frame of soil data from whitman_et_al.
  • toy_metadata - (Data) Data frame of covariate information about toy_otu_table.
  • toy_otu_table - (Data) A toy OTU table.
  • toy_taxonomy - (Data) The taxonomy of the OTUs in 'toy_otu_table'.

On CRAN:

Conda:

8.79 score 68 stars 287 scripts 621 downloads 45 exports 68 dependencies

Last updated from:35f83d47f1. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK347
source / vignettesOK308
linux-release-x86_64OK394
macos-release-arm64OK254
macos-oldrel-arm64OK218
windows-develOK294
windows-releaseOK283
windows-oldrelOK283
wasm-releaseOK185

Exports:%>%alpha_estimatealpha_estimatesbettabetta_lincombetta_picbetta_randombreakawaybreakaway_nof1build_frequency_count_tableschao_bungechao_shenchao1chao1_bcconvertF_testgood_turingkempmake_design_matrixmake_frequency_count_tableobjective_bayes_geometricobjective_bayes_mixedgeoobjective_bayes_negbinobjective_bayes_poissonpoisson_modelpoisson_model_nof1proportions_insteadrnbinomtablerztnbinomtablesample_inverse_simpsonsample_richnesssample_shannonsample_shannon_esample_simpsonsample_size_estimatesample_size_figuretest_submodeltrue_ginitrue_hilltrue_inverse_simpsontrue_shannontrue_shannon_etrue_simpsonwlrm_transformedwlrm_untransformed

Dependencies:ade4apeBiobaseBiocGenericsbiomformatBiostringsbootcliclustercodetoolscpp11crayondata.tabledigestfarverforeachgenericsggplot2gluegtableigraphIRangesisobanditeratorsjsonlitelabelinglatticelifecyclelme4magrittrMASSMatrixmgcvminqamulttestnlmenloptrpermutephyloseqpillarpixmappkgconfigplyrR6rbibutilsRColorBrewerRcppRcppArmadilloRcppEigenRdpackreformulasreshape2rlangS4VectorsS7scalesSeqinfospstringistringrsurvivaltibbleutf8vctrsveganviridisLitewithrXVector

Getting started with breakaway
Vignette Info | Diving in! | Creating frequency tables | Estimating species richness | Next steps
Rendered frombreakaway.Rmdusingknitr::rmarkdown

Last update: 2026-04-14
Started: 2017-09-21

Introduction to diversity estimation
Preliminaries | Why bother with species richness estimation? | How does species richness estimation work? | Estimating the diversity of human host associated microbes | Species richness estimation with breakaway | Investigating model misspecification | Conclusions | Postscript on model selection
Rendered fromintro-diversity-estimation.Rmdusingknitr::rmarkdown

Last update: 2026-04-14
Started: 2019-07-31

Introduction to hypothesis testing for diversity
Disclaimer | Preliminaries | Inference
Rendered fromdiversity-hypothesis-testing.Rmdusingknitr::rmarkdown

Last update: 2026-04-14
Started: 2019-08-15

Readme and manuals

Help Manual

Help pageTopics
alpha_estimatealpha_estimate
alpha_estimatesalpha_estimates
(Data) Frequency count table of soil microbes in an apples orchard.apples
Modelling total diversity with bettabetta
Confidence intervals and testing for linear combinations of fixed effects estimated via betta() or betta_random()betta_lincom
function for plotting total diversitybetta_pic
modelling total diversity with random effectsbetta_random
Species richness estimation with breakawaybreakaway
species richness estimation without singletonsbreakaway_nof1
Build frequency count tables from an OTU tablebuild_frequency_count_tables
Chao-Bunge species richness estimatorchao_bunge
The Chao-Shen estimate of Shannon diversitychao_shen
Chao1 species richness estimatorchao1
Bias-corrected Chao1 species richness estimatorchao1_bc
Run some basic checks on a possible frequency count tablecheck_format
convert between different inputs for alpha-diversity estimatesconvert
Find a cut-off for estimates relying on contiguous countscutoff_wrap
Conduct F test of null hypothesis LB = 0 using output from betta() or betta_random()F_test
Calculate F statistic under null hypothesis LB = 0 using output from betta() or betta_random()get_F_stat
The Good-Turing estimate of species richnessgood_turing
(Data) Frequency count table of soil microbes in Hawaii.hawaii
Species richness estimation with Kemp-type modelskemp
Make design matrixmake_design_matrix
Draw frequency count subtables from an OTU tablemake_frequency_count_table
Estimate species richness with an objective Bayes method using a geometric modelobjective_bayes_geometric
Objective Bayes species richness estimate with the mixed-geometric modelobjective_bayes_mixedgeo
Objective Bayes species richness estimate with the Negative Binomial modelobjective_bayes_negbin
Objective Bayes species richness estimate with the Poisson modelobjective_bayes_poisson
(Data) Data frame of covariate information about pasolli_et_al.pasolli_et_al
Wrapper for phyloseq objectsphyseq_wrap
Plot function for alpha_estimates classplot.alpha_estimates
PoissonModelpoisson_model
PoissonModelNof1poisson_model_nof1
OTU table to relative abundancesproportions_instead
Negative binomially distributed frequency count tables.rnbinomtable
beta version: Zero-truncated negative binomially distributed frequency count tables.rztnbinomtable
Plug-in Inverse Simpson diversitysample_inverse_simpson
Sample richness estimatorsample_richness
Plug-in Shannon diversitysample_shannon
Plug-in Shannon's E ("Equitability")sample_shannon_e
Plug-in Simpson diversitysample_simpson
Estimate the sample size needed to do an unpaired one-way test using bettasample_size_estimate
Plot the power obtained with sample sizesample_size_figure
Simulate from a fitted betta modelsimulate_betta
Simulate from a fitted betta_random modelsimulate_betta_random
(Data) Data frame of soil data from whitman_et_al.soil_phylo
Conduct F test of null hypothesis LB = 0 using output from betta() or betta_random()test_submodel
(Data) Data frame of covariate information about toy_otu_table.toy_metadata
(Data) A toy OTU table.toy_otu_table
(Data) The taxonomy of the OTUs in `toy_otu_table`.toy_taxonomy
Calculate the true Gini-Simpson indextrue_gini
Calculate the true Hill numberstrue_hill
Calculate the true Inverse Simpson indextrue_inverse_simpson
Calculate the true Shannon index based on proportionstrue_shannon
Calculate the true Shannon's equitability indextrue_shannon_e
Calculate the true Simpson indextrue_simpson
The transformed weighted linear regression estimator for species richness estimationwlrm_transformed
The untransformed weighted linear regression estimator for species richness estimationwlrm_untransformed