# Tutorial on Data Sanity and Integrity Checks

    knitr::opts_chunk$set(warning = FALSE, comment = NA,
                          fig.width = 6.25, fig.height = 5)
    library(ANCOMBC)
    library(tidyverse)

# 1. Introduction

The `data_sanity_check` function performs essential validations on the input data to ensure its integrity before further processing. It verifies data types, confirms the structure of the input data, and checks for consistency between sample names in the metadata and the feature table, safeguarding against common data input errors.

# 2. Installation

Download package.

    if (!requireNamespace("BiocManager", quietly = TRUE))
        install.packages("BiocManager")
    BiocManager::install("ANCOMBC")

Load the package.

    library(ANCOMBC)

# 3. Examples

## 3.1 Import a `phyloseq` object

The HITChip Atlas dataset contains genus-level microbiota profiling with HITChip for 1006 western adults with no reported health complications, reported in (Lahti et al. 2014). The dataset is available via the microbiome R package (Lahti et al. 2017) in phyloseq (McMurdie and Holmes 2013) format.

    data(atlas1006, package = "microbiome")

    atlas1006

    phyloseq-class experiment-level object
    otu_table()   OTU Table:         [ 130 taxa and 1151 samples ]
    sample_data() Sample Data:       [ 1151 samples by 10 sample variables ]
    tax_table()   Taxonomy Table:    [ 130 taxa by 3 taxonomic ranks ]

List the taxonomic levels available for data aggregation.

    phyloseq::rank_names(atlas1006)

    [1] "Phylum" "Family" "Genus"

List the variables available in the sample metadata.

    colnames(microbiome::meta(atlas1006))

     [1] "age"                   "sex"                   "nationality"
     [4] "DNA_extraction_method" "project"               "diversity"
     [7] "bmi_group"             "subject"               "time"
    [10] "sample"

Data sanity and integrity check.

    # With `group` variable
    check_results = data_sanity_check(data = atlas1006,
                                      tax_level = "Family",
                                      fix_formula = "age + sex + bmi_group",
                                      group = "bmi_group",
                                      struc_zero = TRUE,
                                      global = TRUE,
                                      verbose = TRUE)

    Checking the input data type ...

    The input data is of type: phyloseq

    PASS

    Checking the sample metadata ...

    The specified variables in the formula: age, sex, bmi_group

    The available variables in the sample metadata: age, sex, nationality, DNA_extraction_method, project, diversity, bmi_group, subject, time, sample

    PASS

    Checking other arguments ...

    The number of groups of interest is: 6

    The sample size per group is: underweight = 21, lean = 484, overweight = 197, obese = 222, severeobese = 99, morbidobese = 22

    PASS

    # Without `group` variable
    check_results = data_sanity_check(data = atlas1006,
                                      tax_level = "Family",
                                      fix_formula = "age + sex + bmi_group",
                                      group = NULL,
                                      struc_zero = FALSE,
                                      global = FALSE,
                                      verbose = TRUE)

    Checking the input data type ...

    The input data is of type: phyloseq

    PASS

    Checking the sample metadata ...

    The specified variables in the formula: age, sex, bmi_group

    The available variables in the sample metadata: age, sex, nationality, DNA_extraction_method, project, diversity, bmi_group, subject, time, sample

    PASS

    Checking other arguments ...

    PASS

## 3.2 Import a `tse` object

    tse = mia::convertFromPhyloseq(atlas1006)

List the taxonomic levels available for data aggregation.

    mia::taxonomyRanks(tse)

    [1] "Phylum" "Family" "Genus"

List the variables available in the sample metadata.

    colnames(SummarizedExperiment::colData(tse))

     [1] "age"                   "sex"                   "nationality"
     [4] "DNA_extraction_method" "project"               "diversity"
     [7] "bmi_group"             "subject"               "time"
    [10] "sample"

Data sanity and integrity check.

    check_results = data_sanity_check(data = tse,
                                      assay_name = "counts",
                                      tax_level = "Family",
                                      fix_formula = "age + sex + bmi_group",
                                      group = "bmi_group",
                                      struc_zero = TRUE,
                                      global = TRUE,
                                      verbose = TRUE)

    Checking the input data type ...

    The input data is of type: TreeSummarizedExperiment

    PASS

    Checking the sample metadata ...

    The specified variables in the formula: age, sex, bmi_group

    The available variables in the sample metadata: age, sex, nationality, DNA_extraction_method, project, diversity, bmi_group, subject, time, sample

    PASS

    Checking other arguments ...

    The number of groups of interest is: 6

    The sample size per group is: underweight = 21, lean = 484, overweight = 197, obese = 222, severeobese = 99, morbidobese = 22

    PASS

## 3.3 Import a `matrix` or `data.frame`

Both abundance data and sample metadata are required for this import method.

Note that aggregating taxa to higher taxonomic levels is not supported in this method. Ensure that the data is already aggregated to the desired taxonomic level before proceeding. If aggregation is needed, consider creating a `phyloseq` or `tse` object for importing.

    abundance_data = microbiome::abundances(atlas1006)
    meta_data = microbiome::meta(atlas1006)

Ensure that the `rownames` of the metadata correspond to the `colnames` of the abundance data.

    all(rownames(meta_data) %in% colnames(abundance_data))

    [1] TRUE

List the variables available in the sample metadata.

    colnames(meta_data)

     [1] "age"                   "sex"                   "nationality"
     [4] "DNA_extraction_method" "project"               "diversity"
     [7] "bmi_group"             "subject"               "time"
    [10] "sample"

Data sanity and integrity check.

    check_results = data_sanity_check(data = abundance_data,
                                      assay_name = "counts",
                                      tax_level = "Family",
                                      meta_data = meta_data,
                                      fix_formula = "age + sex + bmi_group",
                                      group = "bmi_group",
                                      struc_zero = TRUE,
                                      global = TRUE,
                                      verbose = TRUE)

    Checking the input data type ...

    The input data is of type: matrix

    The imported data is in a generic 'matrix'/'data.frame' format.

    PASS

    Checking the sample metadata ...

    The specified variables in the formula: age, sex, bmi_group

    The available variables in the sample metadata: age, sex, nationality, DNA_extraction_method, project, diversity, bmi_group, subject, time, sample

    PASS

    Checking other arguments ...

    The number of groups of interest is: 6

    The sample size per group is: underweight = 21, lean = 484, overweight = 197, obese = 222, severeobese = 99, morbidobese = 22

    PASS

# Session information

    sessionInfo()

    R version 4.5.2 (2025-10-31)
    Platform: x86_64-pc-linux-gnu
    Running under: Ubuntu 24.04.3 LTS

    Matrix products: default
    BLAS:   /usr/lib/x86_64-linux-gnu/openblas-pthread/libblas.so.3
    LAPACK: /usr/lib/x86_64-linux-gnu/openblas-pthread/libopenblasp-r0.3.26.so;  LAPACK version 3.12.0

    locale:
     [1] LC_CTYPE=en_US.UTF-8       LC_NUMERIC=C
     [3] LC_TIME=en_US.UTF-8        LC_COLLATE=C
     [5] LC_MONETARY=en_US.UTF-8    LC_MESSAGES=en_US.UTF-8
     [7] LC_PAPER=en_US.UTF-8       LC_NAME=C
     [9] LC_ADDRESS=C               LC_TELEPHONE=C
    [11] LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C

    time zone: Etc/UTC
    tzcode source: system (glibc)

    attached base packages:
    [1] stats     graphics  grDevices utils     datasets  methods   base

    other attached packages:
     [1] doRNG_1.8.6.2   rngtools_1.5.2  foreach_1.5.2   DT_0.34.0
     [5] lubridate_1.9.4 forcats_1.0.1   stringr_1.6.0   dplyr_1.1.4
     [9] purrr_1.2.0     readr_2.1.5     tidyr_1.3.1     tibble_3.3.0
    [13] ggplot2_4.0.0   tidyverse_2.0.0 ANCOMBC_2.12.0  rmarkdown_2.30

    loaded via a namespace (and not attached):
      [1] ggtext_0.1.2                    fs_1.6.6
      [3] matrixStats_1.5.0               DirichletMultinomial_1.53.0
      [5] httr_1.4.7                      RColorBrewer_1.1-3
      [7] doParallel_1.0.17               numDeriv_2016.8-1.1
      [9] tools_4.5.2                     backports_1.5.0
     [11] R6_2.6.1                        vegan_2.7-2
     [13] lazyeval_0.2.2                  mgcv_1.9-4
     [15] rhdf5filters_1.23.0             permute_0.9-8
     [17] withr_3.0.2                     gridExtra_2.3
     [19] textshaping_1.0.4               cli_3.6.5
     [21] Biobase_2.71.0                  sandwich_3.1-1
     [23] labeling_0.4.3                  slam_0.1-55
     [25] sass_0.4.10                     mvtnorm_1.3-3
     [27] S7_0.2.0                        proxy_0.4-27
     [29] systemfonts_1.3.1               yulab.utils_0.2.1
     [31] foreign_0.8-90                  scater_1.39.0
     [33] decontam_1.31.0                 parallelly_1.45.1
     [35] readxl_1.4.5                    fillpattern_1.0.2
     [37] rstudioapi_0.17.1               generics_0.1.4
     [39] gtools_3.9.5                    crosstalk_1.2.2
     [41] rbiom_2.2.1                     Matrix_1.7-4
     [43] biomformat_1.39.0               ggbeeswarm_0.7.2
     [45] DescTools_0.99.60               S4Vectors_0.49.0
     [47] DECIPHER_3.7.0                  abind_1.4-8
     [49] lifecycle_1.0.4                 multcomp_1.4-29
     [51] yaml_2.3.10                     SummarizedExperiment_1.41.0
     [53] rhdf5_2.55.7                    SparseArray_1.11.1
     [55] Rtsne_0.17                      grid_4.5.2
     [57] crayon_1.5.3                    lattice_0.22-7
     [59] haven_2.5.5                     beachmat_2.27.0
     [61] sys_3.4.3                       maketools_1.3.2
     [63] pillar_1.11.1                   knitr_1.50
     [65] GenomicRanges_1.63.0            boot_1.3-32
     [67] gld_2.6.8                       estimability_1.5.1
     [69] codetools_0.2-20                glue_1.8.0
     [71] data.table_1.17.8               MultiAssayExperiment_1.37.1
     [73] vctrs_0.6.5                     treeio_1.35.0
     [75] Rdpack_2.6.4                    cellranger_1.1.0
     [77] gtable_0.3.6                    cachem_1.1.0
     [79] xfun_0.54                       rbibutils_2.4
     [81] S4Arrays_1.11.0                 Seqinfo_1.1.0
     [83] reformulas_0.4.2                survival_3.8-3
     [85] SingleCellExperiment_1.33.0     iterators_1.0.14
     [87] bluster_1.21.0                  gmp_0.7-5
     [89] TH.data_1.1-4                   nlme_3.1-168
     [91] phyloseq_1.55.0                 bit64_4.6.0-1
     [93] bslib_0.9.0                     irlba_2.3.5.1
     [95] vipor_0.4.7                     rpart_4.1.24
     [97] colorspace_2.1-2                BiocGenerics_0.57.0
     [99] DBI_1.2.3                       Hmisc_5.2-4
    [101] nnet_7.3-20                     ade4_1.7-23
    [103] Exact_3.3                       tidyselect_1.2.1
    [105] emmeans_2.0.0                   bit_4.6.0
    [107] compiler_4.5.2                  microbiome_1.33.0
    [109] htmlTable_2.4.3                 BiocNeighbors_2.5.0
    [111] expm_1.0-0                      xml2_1.4.1
    [113] DelayedArray_0.37.0             checkmate_2.3.3
    [115] scales_1.4.0                    rappdirs_0.3.3
    [117] digest_0.6.37                   minqa_1.2.8
    [119] XVector_0.51.0                  htmltools_0.5.8.1
    [121] pkgconfig_2.0.3                 base64enc_0.1-3
    [123] lme4_1.1-37                     sparseMatrixStats_1.23.0
    [125] MatrixGenerics_1.23.0           fastmap_1.2.0
    [127] rlang_1.1.6                     htmlwidgets_1.6.4
    [129] DelayedMatrixStats_1.33.0       farver_2.1.2
    [131] jquerylib_0.1.4                 zoo_1.8-14
    [133] jsonlite_2.0.0                  energy_1.7-12
    [135] BiocParallel_1.45.0             BiocSingular_1.27.0
    [137] magrittr_2.0.4                  Formula_1.2-5
    [139] scuttle_1.21.0                  patchwork_1.3.2
    [141] Rhdf5lib_1.33.0                 Rcpp_1.1.0
    [143] ape_5.8-1                       ggnewscale_0.5.2
    [145] viridis_0.6.5                   CVXR_1.0-15
    [147] stringi_1.8.7                   rootSolve_1.8.2.4
    [149] MASS_7.3-65                     plyr_1.8.9
    [151] parallel_4.5.2                  ggrepel_0.9.6
    [153] lmom_3.2                        Biostrings_2.79.2
    [155] splines_4.5.2                   gridtext_0.1.5
    [157] multtest_2.67.0                 hms_1.1.4
    [159] igraph_2.2.1                    buildtools_1.0.0
    [161] reshape2_1.4.4                  stats4_4.5.2
    [163] ScaledMatrix_1.19.0             evaluate_1.0.5
    [165] nloptr_2.2.1                    tzdb_0.5.0
    [167] rsvd_1.0.5                      Rmpfr_1.1-2
    [169] e1071_1.7-16                    tidytree_0.4.6
    [171] viridisLite_0.4.2               class_7.3-23
    [173] ragg_1.5.0                      gsl_2.1-9
    [175] lmerTest_3.1-3                  beeswarm_0.4.0
    [177] IRanges_2.45.0                  cluster_2.1.8.1
    [179] TreeSummarizedExperiment_2.19.0 timechange_0.3.0
    [181] mia_1.19.0

# References

Lahti, Leo, Jarkko Salojärvi, Anne Salonen, Marten Scheffer, and Willem M De Vos. 2014. “Tipping Elements in the Human Intestinal Ecosystem.” Nature Communications 5 (1): 1–10.
Lahti, Leo, Sudarshan Shetty, T Blake, J Salojarvi, et al. 2017. “Tools for Microbiome Analysis in r.” Version 1: 10013.
McMurdie, Paul J, and Susan Holmes. 2013. “Phyloseq: An r Package for Reproducible Interactive Analysis and Graphics of Microbiome Census Data.” PloS One 8 (4): e61217.