Skip to content

Document differential abundance and add community files - #133

Closed
hyperpolymath wants to merge 0 commit into
mainfrom
docs/readme-da-coc-templates
Closed

hyperpolymath wants to merge 0 commit into
mainfrom
docs/readme-da-coc-templates

Conversation

@hyperpolymath

Copy link
Copy Markdown
Owner

README: describe the Differential Abundance tab as main ships it (negative-binomial GLM per taxon via MASS::glm.nb, TSS or RLE offset, min_prevalence, BH over fitted taxa, per-taxon statuses, CSV output and every refusal), add analysis.differential to the analysis config block and the exclusion surfaces, list the differential route in the REST table, and link the wiki in metadatastician/MetaManifold-Evidence.

Add CODE_OF_CONDUCT.md (Contributor Covenant 2.1), bug and feature issue forms, and a pull request template that follows CONTRIBUTING.md.

Claude-Session: https://claude.ai/code/session_01X3hgXxWm6umMgZkjYyHnnm

Summary

Closes #

Type of change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (would change existing behaviour)
  • 🕳️ Soundness fix (fixes a checker/proof false-negative)
  • 📖 Documentation
  • 🧹 Refactor / tech debt (behaviour-preserving)
  • ⚡ Performance
  • 🔧 Build / CI / tooling

How has this been verified?

Checklist

  • My commits are signed (git commit -S).
  • I ran the project's own checks/tests locally and they pass.
  • New files carry the correct SPDX-License-Identifier (code/config MPL-2.0,
    prose CC-BY-SA-4.0); I did not relicense existing files.
  • Docs are updated, and no public claim now overstates what the code does.
  • I have not introduced a soundness hole (or I have flagged where I might have).

Notes for reviewers

@coderabbitai

coderabbitai Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 32 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 0e266478-3648-4aba-9159-33428d8c6183
📥 Commits

Reviewing files that changed from the base of the PR and between 655c4da and dcd5af4.

⛔ Files ignored due to path filters: 1
  • renv.lock is excluded by !**/*.lock
📒 Files selected for processing: 56
  • .github/ISSUE_TEMPLATE/bug_report.yml
  • .github/ISSUE_TEMPLATE/feature_request.yml
  • .github/pull_request_template.md
  • .github/workflows/ci.yml
  • .gitignore
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • README.md
  • config/defaults/pipeline.yml
  • frontend/src/api/types.ts
  • frontend/src/components/AnalysisWorkspace.tsx
  • frontend/src/components/CompositionPanel.tsx
  • frontend/src/components/DifferentialPanel.tsx
  • frontend/src/components/DiversityPanel.tsx
  • frontend/src/components/PipelineStages.tsx
  • frontend/src/components/TaxaCompositionChart.tsx
  • frontend/src/components/VennPanel.tsx
  • frontend/src/components/annotationShared.test.ts
  • frontend/src/components/annotationShared.ts
  • frontend/src/components/differentialTable.test.ts
  • frontend/src/components/differentialTable.ts
  • frontend/src/components/sharedRanks.test.ts
  • frontend/src/components/sharedRanks.ts
  • frontend/src/hooks/useApi.test.ts
  • frontend/src/hooks/useApi.ts
  • proofs/agda/MetaManifold/All.agda
  • proofs/agda/MetaManifold/BenjaminiHochberg.agda
  • proofs/agda/MetaManifold/Prelude.agda
  • proofs/agda/MetaManifold/Scaling.agda
  • proofs/agda/README.md
  • proofs/agda/metamanifold.agda-lib
  • proofs/tests/axiom-audit.sh
  • src/MetaManifold.jl
  • src/analysis/analysis.jl
  • src/analysis/differential.jl
  • src/core/memory_probe.jl
  • src/core/provenance.jl
  • src/core/validate.jl
  • src/pipeline/tools.jl
  • src/server/routes/analysis.jl
  • src/server/routes/config.jl
  • src/server/routes/databases.jl
  • src/server/routes/pipeline.jl
  • src/server/routes/report.jl
  • src/server/routes/results.jl
  • src/server/server.jl
  • test/integration/test_pipeline.jl
  • test/occupancy_disagreement_test.jl
  • test/runtests.jl
  • test/unit/test_differential.jl
  • test/unit/test_install_pins.jl
  • test/unit/test_permanova.jl
  • test/unit/test_r_runtime.jl
  • test/unit/test_routes.jl
  • test/unit/test_server_security.jl
  • test/unit/test_write_gates.jl
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@hyperpolymath

Copy link
Copy Markdown
Owner Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
⚠️ Action not completed

Review rate limited.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@hyperpolymath
hyperpolymath force-pushed the docs/readme-da-coc-templates branch from 0de806d to dcd5af4 Compare October 15, 2026 03:15
@hyperpolymath
hyperpolymath force-pushed the docs/readme-da-coc-templates branch from dcd5af4 to 655c4da Compare October 15, 2026 03:28
@sonarqubecloud

Copy link
Copy Markdown

@hyperpolymath

Copy link
Copy Markdown
Owner Author

For the record: this PR's head tracking got wedged during the branch cleanup (the branch was briefly pushed to the base commit and never picked up updates again -- head stuck at 655c4da, 0 files, while the branch itself was corrected to 576276f). The same branch and change now live in #143: README wiki pointer + differential-abundance documentation, the issue/PR templates, and the code of conduct under .github/ per the root-shape doctrine, one commit on the current main tip, mergeable.

hyperpolymath added a commit that referenced this pull request Oct 15, 2026
… community files (#143)

## What this changes

Three things a newcomer meets before any code (replaces the wedged #133,
whose head got stuck at the base commit during branch cleanup; same
branch, same change, clean start):

1. **A Documentation section in the README** pointing at the wiki in
[metadatastician/MetaManifold-Evidence, under
`docs/wikis/`](https://github.com/metadatastician/MetaManifold-Evidence/tree/main/docs/wikis)
-- the longer documentation for users, maintainers, developers and
theorists, with a Home page entry point.
2. **A Differential Abundance section in the README**, documenting the
tab end to end: the two-condition selection (exactly two runs or
pooled-run sub-groups, the first as reference so a positive fold change
means more abundant in the second), the rank list showing only ranks the
selected runs share, aggregation making a pooled run one condition, and
then the statistics as the code runs them -- counts summed per taxon at
the chosen rank with nameless rows pooled as `Unclassified` after the
read-count bounds and any applicable `analysis.exclude_categories`; each
taxon fitted with its own negative-binomial GLM `MASS::glm.nb(y ~ group
+ offset(log(size factor)))` on raw integer counts, no pseudocounts; a
Wald test on the group coefficient; Benjamini-Hochberg over the taxa
that produced a p-value; size factors from the whole matrix, centred.
Cross-references the existing `Configuring analysis` anchor for the
settings, and names the code (`src/analysis/differential.jl`) and the
route.
3. **The community files**: a bug report and a feature request issue
template (both telling reporters to search existing issues first, and to
raise a fork's own issues on that fork), a pull request template
carrying the PR checklist, and the Contributor Covenant code of conduct.
Per this fork's root-shape doctrine the code of conduct lives under
`.github/` with `CONTRIBUTING.md` -- the root keeps only authority files
and entry points, and `test/unit/test_install_pins.jl`'s bidirectional
root check stays green without touching its allowlist.

## How to run its tests

Documentation and `.github/` convention files; no code changes. Verified
locally on a branch cut from the current `main` tip (`655c4da`, i.e.
including the merged occupancy gate):

```
julia --project=. test/unit/test_install_pins.jl   # 223/223, root shape 23/23
```

Every file and anchor the new sections reference exists
(`src/analysis/differential.jl`, the `analysis:` settings in
`pipeline.yml`, the `Configuring analysis` heading at line 623 that the
cross-reference at line 271 points at, this fork's `scripts/install.jl`
path untouched), and the templates are the issue-form YAML GitHub
expects.

## What this leaves out

No changes to any workflow, so nothing for the occupancy gate or the
action allow-list to weigh. The commit is unsigned (the signing key's
passphrase is unavailable to the session that produced it); amend to
sign if required. This same change is also proposed upstream as
JoshuaJewell#47, with the one fork-specific
difference noted above (the code of conduct's location).

## Versions tested

Julia 1.13.1 locally (CI pins 1.12.5). Nothing else touched.

---------

Generated by Mistral Vibe.
Co-Authored-By: Mistral Vibe <vibe@mistral.ai>

Co-authored-by: Mistral Vibe <vibe@mistral.ai>
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.

1 participant