# Reproducibility in Microbiome Data Analysis

Reproducibility is a crucial aspect of data analysis, particularly in the context of microbiome data. The ability to consistently replicate an analysis and obtain the same results is essential for ensuring the reliability of findings and facilitating scientific collaboration.

The `dar` package includes two key functions, `export_steps` and `import_steps`, which promote reproducibility in microbiome data analysis. These functions allow you to export the steps of a recipe to a JSON file and then import those steps to reproduce the analysis in a different environment.

## Exporting Steps of a Recipe

The `export_steps` function facilitates the export of a recipe’s steps to a JSON file. This is useful for documenting and sharing the parameters used in the analysis.

Here’s an example of how to use the `export_steps` function:

    library(dar)
    data(metaHIV_phy)

    # Create a recipe with steps
    rec <-
      recipe(metaHIV_phy, "RiskGroup2", "Species") |>
      step_subset_taxa(tax_level = "Kingdom", taxa = c("Bacteria", "Archaea")) |>
      step_filter_taxa(.f = "function(x) sum(x > 0) >= (0.3 * length(x))") |>
      step_maaslin()

    # Export the steps to a JSON file
    out_file <- tempfile(fileext = ".json")
    export_steps(rec, out_file)

In this example, a recipe with multiple steps is created, and then the steps are exported to a JSON file using the `export_steps` function.

## Importing Steps from a JSON File

The `import_steps` function allows you to import steps from a JSON file and add them to an existing recipe. This is useful when you want to reuse a previously saved set of steps or incorporate steps from another recipe into your current analysis.

Here’s an example of how to use the `import_steps` function:

    # Initialize a recipe with a phyloseq object
    rec <- recipe(metaHIV_phy, "RiskGroup2", "Species")

    # Import the steps from a JSON file
    json_file <- out_file
    rec <- import_steps(rec, json_file)
    rec
    #> ── DAR Recipe ──────────────────────────────────────────────────────────────────
    #> Inputs:
    #>
    #>      ℹ phyloseq object with 451 taxa and 156 samples
    #>      ℹ variable of interes RiskGroup2 (class: character, levels: hts, msm, pwid)
    #>      ℹ taxonomic level Species
    #>
    #> Preporcessing steps:
    #>
    #>      ◉ step_subset_taxa() id = subset_taxa__Coussin_de_Lyon
    #>      ◉ step_filter_taxa() id = filter_taxa__Knieküchle
    #>
    #> DA steps:
    #>
    #>      ◉ step_maaslin() id = maaslin__Roti_john

In this example, an empty recipe is initialized, and then the steps are imported from a JSON file using the `import_steps` function. The imported steps are added to the existing recipe.

Once the recipe is imported, we can choose to add more steps or execute the code using the `prep` function. In this case, we choose to execute `prep` directly.

    ## Execute
    da_results <- prep(rec, parallel = FALSE) |> bake()
    da_results
    #> ── DAR Results ─────────────────────────────────────────────────────────────────
    #> Inputs:
    #>
    #>      ℹ phyloseq object with 101 taxa and 156 samples
    #>      ℹ variable of interes RiskGroup2 (class: character, levels: hts, msm, pwid)
    #>      ℹ taxonomic level Species
    #>
    #> Results:
    #>
    #>      ✔ maaslin__Roti_john diff_taxa = 86
    #>
    #>      ℹ 86 taxa are present in all tested methods
    #>
    #> Bakes:
    #>
    #>      ◉ 1 -> count_cutoff: NULL, weights: NULL, exclude: NULL, id: bake__Crêpes_Suzette

## Limitations and Considerations

It’s important to note some limitations and considerations when using the `export_steps` and `import_steps` functions:

- The JSON files generated by `export_steps` only contain the parameters of the recipe steps and bakes, not the original data used in the analysis. Therefore, when importing the steps from a JSON file, ensure that you have access to the same data that was originally used.

- The `export_steps` and `import_steps` functions are specific to the `dar` package and are designed for use in microbiome data analysis. They are not applicable to other types of analyses or packages.

- When importing steps from a JSON file, it’s important to check if the file contains “bake” steps. If so, the recipe will be automatically prepared after importing the steps. This may have implications for runtime and resource requirements of the analysis.

- Make sure you have the correct versions of the dependencies of the `dar` package when exporting and importing recipe steps. Updates in dependencies can affect the compatibility and reproducibility of the analyses.

## Conclusion

Reproducibility is essential in microbiome data analysis, and the `dar` package facilitates this aspect by providing the `export_steps` and `import_steps` functions. These functions allow you to export the steps of a recipe to a JSON file and then import them to reproduce the analysis in a different environment. With these tools, you can effectively document and share your analyses, increasing transparency and the reliability of your results.

## Session info

    devtools::session_info()
    #> ─ Session info ───────────────────────────────────────────────────────────────
    #>  setting  value
    #>  version  R version 4.5.2 (2025-10-31)
    #>  os       Ubuntu 24.04.3 LTS
    #>  system   x86_64, linux-gnu
    #>  ui       X11
    #>  language (EN)
    #>  collate  C
    #>  ctype    en_US.UTF-8
    #>  tz       Etc/UTC
    #>  date     2026-01-04
    #>  pandoc   3.6.3 @ /usr/local/bin/ (via rmarkdown)
    #>  quarto   1.8.24 @ /usr/local/bin/quarto
    #>
    #> ─ Packages ───────────────────────────────────────────────────────────────────
    #>  package                  * version   date (UTC) lib source
    #>  abind                      1.4-8     2024-09-12 [2] RSPM (R 4.5.0)
    #>  ade4                       1.7-23    2025-02-14 [2] RSPM (R 4.5.0)
    #>  ape                        5.8-1     2024-12-16 [2] RSPM (R 4.5.0)
    #>  assertthat                 0.2.1     2019-03-21 [2] RSPM (R 4.5.0)
    #>  beachmat                   2.27.1    2025-12-13 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  beeswarm                   0.4.0     2021-06-01 [2] RSPM (R 4.5.0)
    #>  biglm                      0.9-3     2024-06-12 [2] RSPM (R 4.5.0)
    #>  Biobase                  * 2.71.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  BiocGenerics             * 0.57.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  BiocNeighbors              2.5.0     2025-12-14 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  BiocParallel               1.45.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  BiocSingular               1.27.1    2025-11-17 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  biomformat                 1.39.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  Biostrings               * 2.79.3    2025-12-17 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  bit                        4.6.0     2025-03-06 [2] RSPM (R 4.5.0)
    #>  bit64                      4.6.0-1   2025-01-16 [2] RSPM (R 4.5.0)
    #>  bitops                     1.0-9     2024-10-03 [2] RSPM (R 4.5.0)
    #>  bluster                    1.21.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  brio                       1.1.5     2024-04-24 [2] RSPM (R 4.5.0)
    #>  bslib                      0.9.0     2025-01-30 [2] RSPM (R 4.5.0)
    #>  buildtools                 1.0.0     2025-12-31 [3] local (/pkg)
    #>  ca                         0.71.1    2020-01-24 [2] RSPM (R 4.5.0)
    #>  cachem                     1.1.0     2024-05-16 [2] RSPM (R 4.5.0)
    #>  Cairo                      1.7-0     2025-10-29 [2] RSPM (R 4.5.0)
    #>  caTools                    1.18.3    2024-09-04 [2] RSPM (R 4.5.0)
    #>  circlize                   0.4.17    2025-12-08 [2] RSPM (R 4.5.0)
    #>  cli                        3.6.5     2025-04-23 [2] RSPM (R 4.5.0)
    #>  clue                       0.3-66    2024-11-13 [2] RSPM (R 4.5.0)
    #>  cluster                    2.1.8.1   2025-03-12 [2] RSPM (R 4.5.0)
    #>  codetools                  0.2-20    2024-03-31 [2] RSPM (R 4.5.0)
    #>  colorspace                 2.1-2     2025-09-22 [2] RSPM (R 4.5.0)
    #>  ComplexHeatmap             2.27.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  crayon                     1.5.3     2024-06-20 [2] RSPM (R 4.5.0)
    #>  crosstalk                  1.2.2     2025-08-26 [2] RSPM (R 4.5.0)
    #>  dar                      * 1.7.0     2025-10-29 [1] https://bioc.r-universe.dev (R 4.5.2)
    #>  data.table                 1.18.0    2025-12-24 [2] RSPM (R 4.5.0)
    #>  DBI                        1.2.3     2024-06-02 [2] RSPM (R 4.5.0)
    #>  DECIPHER                   3.7.0     2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  decontam                   1.31.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  DelayedArray               0.37.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  DelayedMatrixStats         1.33.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  dendextend                 1.19.1    2025-07-15 [2] RSPM (R 4.5.0)
    #>  DEoptimR                   1.1-4     2025-07-27 [2] RSPM (R 4.5.0)
    #>  devtools                   2.4.6     2025-10-03 [2] RSPM (R 4.5.0)
    #>  digest                     0.6.39    2025-11-19 [2] RSPM (R 4.5.0)
    #>  DirichletMultinomial       1.53.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  doParallel                 1.0.17    2022-02-07 [2] RSPM (R 4.5.0)
    #>  dplyr                      1.1.4     2023-11-17 [2] RSPM (R 4.5.0)
    #>  ecodive                    2.2.1     2025-12-12 [2] RSPM (R 4.5.0)
    #>  ellipsis                   0.3.2     2021-04-29 [2] RSPM (R 4.5.0)
    #>  evaluate                   1.0.5     2025-08-27 [2] RSPM (R 4.5.0)
    #>  farver                     2.1.2     2024-05-13 [2] RSPM (R 4.5.0)
    #>  fastmap                    1.2.0     2024-05-15 [2] RSPM (R 4.5.0)
    #>  foreach                    1.5.2     2022-02-02 [2] RSPM (R 4.5.0)
    #>  fs                         1.6.6     2025-04-12 [2] RSPM (R 4.5.0)
    #>  furrr                      0.3.1     2022-08-15 [2] RSPM (R 4.5.0)
    #>  future                     1.68.0    2025-11-17 [2] RSPM (R 4.5.0)
    #>  generics                 * 0.1.4     2025-05-09 [2] RSPM (R 4.5.0)
    #>  GenomicRanges            * 1.63.1    2025-12-08 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  getopt                     1.20.4    2023-10-01 [2] RSPM (R 4.5.0)
    #>  GetoptLong                 1.1.0     2025-11-28 [2] RSPM (R 4.5.0)
    #>  ggbeeswarm                 0.7.3     2025-11-29 [2] RSPM (R 4.5.0)
    #>  ggplot2                    4.0.1     2025-11-14 [2] RSPM (R 4.5.0)
    #>  ggrepel                    0.9.6     2024-09-07 [2] RSPM (R 4.5.0)
    #>  GlobalOptions              0.1.3     2025-11-28 [2] RSPM (R 4.5.0)
    #>  globals                    0.18.0    2025-05-08 [2] RSPM (R 4.5.0)
    #>  glue                       1.8.0     2024-09-30 [2] RSPM (R 4.5.0)
    #>  gplots                     3.3.0     2025-11-30 [2] RSPM (R 4.5.0)
    #>  gridExtra                  2.3       2017-09-09 [2] RSPM (R 4.5.0)
    #>  gtable                     0.3.6     2024-10-25 [2] RSPM (R 4.5.0)
    #>  gtools                     3.9.5     2023-11-20 [2] RSPM (R 4.5.0)
    #>  hash                       2.2.6.3   2023-08-19 [2] RSPM (R 4.5.0)
    #>  heatmaply                  1.6.0     2025-07-12 [2] RSPM (R 4.5.0)
    #>  hms                        1.1.4     2025-10-17 [2] RSPM (R 4.5.0)
    #>  htmltools                  0.5.9     2025-12-04 [2] RSPM (R 4.5.0)
    #>  htmlwidgets                1.6.4     2023-12-06 [2] RSPM (R 4.5.0)
    #>  httr                       1.4.7     2023-08-15 [2] RSPM (R 4.5.0)
    #>  igraph                     2.2.1     2025-10-27 [2] RSPM (R 4.5.0)
    #>  IRanges                  * 2.45.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  irlba                      2.3.5.1   2022-10-03 [2] RSPM (R 4.5.0)
    #>  iterators                  1.0.14    2022-02-05 [2] RSPM (R 4.5.0)
    #>  jquerylib                  0.1.4     2021-04-26 [2] RSPM (R 4.5.0)
    #>  jsonlite                   2.0.0     2025-03-27 [2] RSPM (R 4.5.0)
    #>  KernSmooth                 2.23-26   2025-01-01 [2] RSPM (R 4.5.0)
    #>  knitr                      1.51      2025-12-20 [2] RSPM (R 4.5.0)
    #>  labeling                   0.4.3     2023-08-29 [2] RSPM (R 4.5.0)
    #>  lattice                    0.22-7    2025-04-02 [2] RSPM (R 4.5.0)
    #>  lazyeval                   0.2.2     2019-03-15 [2] RSPM (R 4.5.0)
    #>  lifecycle                  1.0.4     2023-11-07 [2] RSPM (R 4.5.0)
    #>  listenv                    0.10.0    2025-11-02 [2] RSPM (R 4.5.0)
    #>  logging                    0.10-108  2019-07-14 [2] RSPM (R 4.5.0)
    #>  Maaslin2                   1.23.0    2025-04-15 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  magrittr                   2.0.4     2025-09-12 [2] RSPM (R 4.5.0)
    #>  maketools                  1.3.2     2025-01-25 [3] RSPM (R 4.5.0)
    #>  MASS                       7.3-65    2025-02-28 [2] RSPM (R 4.5.0)
    #>  Matrix                     1.7-4     2025-08-28 [2] RSPM (R 4.5.0)
    #>  MatrixGenerics           * 1.23.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  matrixStats              * 1.5.0     2025-01-07 [2] RSPM (R 4.5.0)
    #>  memoise                    2.0.1     2021-11-26 [2] RSPM (R 4.5.0)
    #>  mgcv                       1.9-4     2025-11-07 [2] RSPM (R 4.5.0)
    #>  mia                      * 1.19.2    2025-12-09 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  microbiome                 1.33.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  MultiAssayExperiment     * 1.37.2    2025-11-14 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  multtest                   2.67.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  mvtnorm                    1.3-3     2025-01-10 [2] RSPM (R 4.5.0)
    #>  nlme                       3.1-168   2025-03-31 [2] RSPM (R 4.5.0)
    #>  optparse                   1.7.5     2024-04-16 [2] RSPM (R 4.5.0)
    #>  otel                       0.2.0     2025-08-29 [2] RSPM (R 4.5.0)
    #>  parallelly                 1.46.0    2025-12-12 [2] RSPM (R 4.5.0)
    #>  pbapply                    1.7-4     2025-07-20 [2] RSPM (R 4.5.0)
    #>  pcaPP                      2.0-5     2024-08-19 [2] RSPM (R 4.5.0)
    #>  permute                    0.9-8     2025-06-25 [2] RSPM (R 4.5.0)
    #>  phyloseq                 * 1.55.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  pillar                     1.11.1    2025-09-17 [2] RSPM (R 4.5.0)
    #>  pkgbuild                   1.4.8     2025-05-26 [2] RSPM (R 4.5.0)
    #>  pkgconfig                  2.0.3     2019-09-22 [2] RSPM (R 4.5.0)
    #>  pkgload                    1.4.1     2025-09-23 [2] RSPM (R 4.5.0)
    #>  plotly                     4.11.0    2025-06-19 [2] RSPM (R 4.5.0)
    #>  plyr                       1.8.9     2023-10-02 [2] RSPM (R 4.5.0)
    #>  png                        0.1-8     2022-11-29 [2] RSPM (R 4.5.0)
    #>  purrr                      1.2.0     2025-11-04 [2] RSPM (R 4.5.0)
    #>  R6                         2.6.1     2025-02-15 [2] RSPM (R 4.5.0)
    #>  rappdirs                   0.3.3     2021-01-31 [2] RSPM (R 4.5.0)
    #>  RColorBrewer               1.1-3     2022-04-03 [2] RSPM (R 4.5.0)
    #>  Rcpp                       1.1.0.8.1 2025-12-16 [2] https://cran.r-universe.dev (R 4.5.2)
    #>  readr                      2.1.6     2025-11-14 [2] RSPM (R 4.5.0)
    #>  registry                   0.5-1     2019-03-05 [2] RSPM (R 4.5.0)
    #>  remotes                    2.5.0     2024-03-17 [2] RSPM (R 4.5.0)
    #>  reshape2                   1.4.5     2025-11-12 [2] RSPM (R 4.5.0)
    #>  rhdf5                      2.55.12   2025-12-10 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  rhdf5filters               1.23.3    2025-12-07 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  Rhdf5lib                   1.33.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  rjson                      0.2.23    2024-09-16 [2] RSPM (R 4.5.0)
    #>  rlang                      1.1.6     2025-04-11 [2] RSPM (R 4.5.0)
    #>  rmarkdown                * 2.30      2025-09-28 [2] RSPM (R 4.5.0)
    #>  robustbase                 0.99-6    2025-09-04 [2] RSPM (R 4.5.0)
    #>  rsvd                       1.0.5     2021-04-16 [2] RSPM (R 4.5.0)
    #>  Rtsne                      0.17      2023-12-07 [2] RSPM (R 4.5.0)
    #>  S4Arrays                   1.11.1    2025-11-25 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  S4Vectors                * 0.49.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  S7                         0.2.1     2025-11-14 [2] RSPM (R 4.5.0)
    #>  sass                       0.4.10    2025-04-11 [2] RSPM (R 4.5.0)
    #>  ScaledMatrix               1.19.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  scales                     1.4.0     2025-04-24 [2] RSPM (R 4.5.0)
    #>  scater                     1.39.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  scuttle                    1.21.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  Seqinfo                  * 1.1.0     2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  seriation                  1.5.8     2025-08-20 [2] RSPM (R 4.5.0)
    #>  sessioninfo                1.2.3     2025-02-05 [2] RSPM (R 4.5.0)
    #>  shape                      1.4.6.1   2024-02-23 [2] RSPM (R 4.5.0)
    #>  SingleCellExperiment     * 1.33.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  SparseArray                1.11.10   2025-12-16 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  sparseMatrixStats          1.23.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  stringi                    1.8.7     2025-03-27 [2] RSPM (R 4.5.0)
    #>  stringr                    1.6.0     2025-11-04 [2] RSPM (R 4.5.0)
    #>  SummarizedExperiment     * 1.41.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  survival                   3.8-3     2024-12-17 [2] RSPM (R 4.5.0)
    #>  sys                        3.4.3     2024-10-04 [2] RSPM (R 4.5.0)
    #>  testthat                   3.3.1     2025-11-25 [2] RSPM (R 4.5.0)
    #>  tibble                     3.3.0     2025-06-08 [2] RSPM (R 4.5.0)
    #>  tidyr                      1.3.2     2025-12-19 [2] RSPM (R 4.5.0)
    #>  tidyselect                 1.2.1     2024-03-11 [2] RSPM (R 4.5.0)
    #>  tidytree                   0.4.6     2023-12-12 [2] RSPM (R 4.5.0)
    #>  treeio                     1.35.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  TreeSummarizedExperiment * 2.19.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  TSP                        1.2.6     2025-11-27 [2] RSPM (R 4.5.0)
    #>  tzdb                       0.5.0     2025-03-15 [2] RSPM (R 4.5.0)
    #>  UpSetR                     1.4.0     2019-05-22 [2] RSPM (R 4.5.0)
    #>  usethis                    3.2.1     2025-09-06 [2] RSPM (R 4.5.0)
    #>  utf8                       1.2.6     2025-06-08 [2] RSPM (R 4.5.0)
    #>  vctrs                      0.6.5     2023-12-01 [2] RSPM (R 4.5.0)
    #>  vegan                      2.7-2     2025-10-08 [2] RSPM (R 4.5.0)
    #>  vipor                      0.4.7     2023-12-18 [2] RSPM (R 4.5.0)
    #>  viridis                    0.6.5     2024-01-29 [2] RSPM (R 4.5.0)
    #>  viridisLite                0.4.2     2023-05-02 [2] RSPM (R 4.5.0)
    #>  vroom                      1.6.7     2025-11-28 [2] RSPM (R 4.5.0)
    #>  webshot                    0.5.5     2023-06-26 [2] RSPM (R 4.5.0)
    #>  withr                      3.0.2     2024-10-28 [2] RSPM (R 4.5.0)
    #>  xfun                       0.55      2025-12-16 [2] RSPM (R 4.5.0)
    #>  XVector                  * 0.51.0    2025-10-29 [2] https://bioc.r-universe.dev (R 4.5.2)
    #>  yaml                       2.3.12    2025-12-10 [2] RSPM (R 4.5.0)
    #>  yulab.utils                0.2.3     2025-12-15 [2] RSPM (R 4.5.0)
    #>
    #>  [1] /tmp/Rtmpj76oA0/Rinst39e55b88005c
    #>  [2] /github/workspace/pkglib
    #>  [3] /usr/local/lib/R/site-library
    #>  [4] /usr/lib/R/site-library
    #>  [5] /usr/lib/R/library
    #>  * ── Packages attached to the search path.
    #>
    #> ──────────────────────────────────────────────────────────────────────────────