Skip to content

Add a oral-enrichment score and a microbiome-diversity-analysis-protocol - #43

Open
ohih8 wants to merge 3 commits into
waldronlab:mainfrom
ohih8:microbiome-diversity-analysis
Open

ohih8 wants to merge 3 commits into
waldronlab:mainfrom
ohih8:microbiome-diversity-analysis

Conversation

@ohih8

@ohih8 ohih8 commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

Calculate within-sample and between-sample microbiome diversity and test whether diversity differs by a prespecified grouping variable.

ohih8 and others added 3 commits September 15, 2026 16:59
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@ohih8
ohih8 requested a review from lwaldron as a code owner September 16, 2026 21:36
@ohih8 ohih8 changed the title Add a microbiome-diversity-analysis-protocol Add a oral-enrichment score and a microbiome-diversity-analysis-protocol Sep 16, 2026
@ohih8

ohih8 commented Sep 16, 2026

Copy link
Copy Markdown
Contributor Author

Note: this PR included both new protocols, which is why I deleted the old PR with just one of them.

@lwaldron

lwaldron commented Sep 17, 2026

Copy link
Copy Markdown
Member

When PRs are related to an issue, include in the Description something like "Closes #n" so that merging the PR will automatically close the issue, and both will cross-reference each other. If not relating to an existing issue, file an issue so you can reference it in the PR.

license: CC-BY-4.0
type: atomic

protocol_citation: "10.1038/s41467-025-66888-1"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cite original research for something this commonly used


# Microbiome Diversity Analysis

This protocol calculates one within-sample diversity value (alpha diversity) for

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Separate alpha diversity protocol from beta-diversity protocol


### Step 1: Define the analysis set and analysis objectives

Specify the body site, participant population, study-design restrictions, repeated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think body site affects how the calculation is performed, and it is not part of the Materials.

### Step 1: Define the analysis set and analysis objectives

Specify the body site, participant population, study-design restrictions, repeated
sample rule, and exclusion criteria before calculating diversity. Retain a record of

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think all this is separate, alpha diversity should just be calculated on an input matrix

every excluded sample and the reason for exclusion. Do not select samples based on
their diversity values or on a result of the group comparison.

State which outputs are required: alpha diversity, beta diversity, alpha-diversity

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inputs should be part of Materials, and could include which measure of alpha or beta diversity is to be calculated


### Step 1: Confirm the input abundance scale and taxonomic identifiers

Use species-level relative abundances for both the oral reference samples and the gut

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good


Require every abundance used in the calculation to be numeric, finite, and
non-negative. Treat an explicit numeric zero as zero. Do not treat a missing value,
blank value, or non-numeric value as zero; resolve it or stop the calculation.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just stop the calculation

different species; stop and report any unresolved identifiers that could affect the
oral signature or its gut-sample abundances.

### Step 2: Select oral-cavity reference samples

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

different protocol


The original study used 857 oral-cavity samples from curatedMetagenomicData 3. A
different reference collection may be used, but its source, body-site definition,
sample count, and study composition must be recorded because they determine the

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

superfluous

@@ -0,0 +1,211 @@
---

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Try to compress without loss of precision

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants