waldronlab / waldronlab/agent-protocols

Composite protocol: cross-study meta-analysis of a host covariate in curatedMetagenomicData

Open
#34 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

advanced blocked composite-protocol microbiome statistics
Dominant language
No language data
Stars
0
Forks
1
Avg merge
1h 2m
Merged PRs (30d)
9

Description

Tier: D (capstone-scale) · Type: composite · Category: Statistical Analysis

What

The full pipeline, end to end: assemble datasets meeting the inclusion criteria → filter and CLR-transform → per-dataset covariate-adjusted effect sizes → random-effects pooling with heterogeneity → FDR correction → forest plots and a reportable results table. Parameterized by the covariate, so age, sex, BMI, or a new one are the same protocol with different inputs.

Why it matters

This is the "apply to new data" deliverable for the cMD side. Running it against a newer cMD release with the covariate set to age should reproduce the paper's age results; running it with a new covariate is a new analysis with no new methods work. It is also the proof that the Tier D atomic protocols compose.

Source material

  • waldronlab/curatedMetagenomicDataAnalysesvignettes/Age_metaanalysis_vignette.Rmd and vignettes/Sex_metaanalysis_vignette.Rmd as the two reference implementations; python_tools/metaanalyze.py, one_feature_forest_plot.py, plot_meta_analysis.py, draw_figure_with_ma.py; cMD3_paper_analyses/all_command_lines_py.sh SECTION 1
  • Paper: 10.1038/s41467-025-66888-1

Scope

In: the ordering of component protocols and the hand-off between them; the binary-vs-continuous branch (SMD or Fisher-Z partial correlation); which feature types are run (species, genus, pathways, KOs) and whether multiple testing is applied within or across them; the required contents of the results report.

Out: every step a component protocol already specifies.

Frontmatter starting point

type: "composite"
category: "Statistical Analysis"
citation: "10.1038/s41467-025-66888-1"
protocols_used:
  - name: "cmd-cohort-assembly"
  - name: "clr-transformation"
  - name: "per-dataset-smd-covariate-adjusted"
  - name: "partial-correlation-fisher-z"
  - name: "random-effects-meta-analysis-pm"

Acceptance criteria

  • Reproduces the published age meta-analysis on the paper's cMD version
  • The binary/continuous branch is explicit and both paths are covered
  • States whether multiple testing is applied within or across feature types
  • Blocked on its component protocols merging first

Cite the method's origin, not its users

PROTOCOL_STANDARD.md is explicit: an atomic protocol carries "strictly 1 citation... corresponding
to the primary literature where the method was originally published."
Find the paper that proposed
the method. Do not cite a paper that merely applied it — including the BugSigDB and curatedMetagenomicData
papers, which are the source of the analysis these protocols were extracted from but almost never the
source of the method.

Tracing a method back to its first publication is real work, and it is part of the task, not a
formality. Three things to expect:

  • Candidate DOIs in this issue are leads, not answers. Anything marked VERIFY has not been checked.
  • Some methods predate modern citation practice or have no single identifiable origin. If that is
    genuinely the case, say so in the pull request rather than reaching for a convenient recent paper.
    Raise it as an issue in waldronlab/agent-protocol-standard — the standard may need a way to express
    "classical method, no primary source".
  • If you cannot name one paper that proposed everything the protocol does, it is more than one
    protocol.
    That test has now split four protocols out of this batch: enrichment into three methods,
    filtering from transformation, LODO from random forest, and PERMANOVA from ANOSIM.

Where the lab's own paper genuinely did propose the method — the oral-to-gut score, and LODO
cross-validation in Pasolli et al. 2016 — citing it is correct. That is the exception, not the pattern.

Before you start

Read CONTRIBUTING.md and
PROTOCOL_STANDARD.md.
The format is defined in the standard repo, not this one. Protocols are prose, not code: they say what to do
and why, precisely enough that two people — or two agents, in two languages — get the same answer. The existing
independent-filtering-variance
protocol is the model to imitate for tone and level of detail.

Validate locally before opening the PR:

git clone https://github.com/waldronlab/agent-protocol-standard.git
Rscript agent-protocol-standard/scripts/validate-protocol.R protocols

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read CONTRIBUTING.md, PROTOCOL_STANDARD.md, and protocols/independent-filtering-variance/protocol.md first. Compare vignettes/Age_metaanalysis_vignette.Rmd, vignettes/Sex_metaanalysis_vignette.Rmd, the listed Python tools, and SECTION 1 of cMD3_paper_analyses/all_command_lines_py.sh to specify component ordering, branches, feature scopes, citations, and report contents. Done means the composite protocol meets every acceptance criterion and passes validate-protocol.R after its component protocols are available.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, r
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.