Add ecosystem package documentation page#1064
Open
xushenbo wants to merge 2 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Body
PR Checklist
docsis updatedDescription of changes
This PR adds a small ecosystem documentation page to describe specialized packages that build on ehrapy without expanding the core API.
The immediate motivation is reviewer feedback on a self-controlled cohort drug-screening workflow based on Foundational Model-aided Automatic High-throughput Drug Screening Using Self-controlled Cohort Study. Rather than adding that setup-specific workflow directly into
ehrapy.tools, the workflow now lives in the separateehrapy-drug-screeningecosystem package with its own implementation, tests, documentation, and tutorial notebooks.The new docs page explains that the future ecosystem package is intended to cover:
Technical details
This PR intentionally keeps
ehrapyfocused on foundational EHR analysis. It does not add the full drug-screening implementation toehrapy-main; that work is hosted separately in a standalone ecosystem package generated from the scverse package template.Main changes:
docs/ecosystem.mddocs/index.mdValidation performed locally:
git diff --checkDocs build note:
ehrapy-maindocs build was not rerun after this docs-only change because the localehrapy-mainenvironment is missingsphinx_tabs. The ecosystem package itself was validated withpytestand a Sphinx-Wdocs build.Additional context
This PR is a scoped documentation update that aligns with the reviewer recommendation: keep the specialized drug-screening workflow in a dedicated ecosystem package, and reference that ecosystem expansion from ehrapy documentation.