docs: document keep_abundant_per_category and identify_abundant_per_category (PR #341)#342
docs: document keep_abundant_per_category and identify_abundant_per_category (PR #341)#342stemangiola with Copilot wants to merge 3 commits into
Conversation
…y functions (PR #341) Agent-Logs-Url: https://github.com/tidyomics/tidybulk/sessions/6629bc9d-eb57-4447-8225-94694486a312 Co-authored-by: stemangiola <7232890+stemangiola@users.noreply.github.com>
| objects and follow tidyverse principles for seamless integration with | ||
| the tidyverse ecosystem. | ||
|
|
||
| ## Category-aware abundance filtering |
There was a problem hiding this comment.
@copilot this description you added in README is better done in Vognette, where we do the filtering
There was a problem hiding this comment.
Moved the detailed description to the vignette. README now only lists the two new functions in the Filtering and Selection Functions table (commit a72428f).
Agent-Logs-Url: https://github.com/tidyomics/tidybulk/sessions/35559420-c05c-4207-b057-63d818bca5a4 Co-authored-by: stemangiola <7232890+stemangiola@users.noreply.github.com>
I'm unable to directly push to another PR's branch — I can only commit to the current branch. To incorporate these documentation changes into PR #341, you can cherry-pick the commits from this branch: git checkout <pr-341-branch>
git cherry-pick 58ea22e # original docs commit
git cherry-pick a72428f # README cleanup commit
git pushAlternatively, you can close this PR and add the documentation changes directly to PR #341's branch. |
|
@GaoYingnan can you please merge this changes to your PR? |
PR #341 introduced
keep_abundant_per_category()andidentify_abundant_per_category()as category-aware alternatives to global abundance filtering. This PR adds user-facing documentation so the feature is discoverable and correctly applied.Changes
README.mdvignettes/introduction.Rmdkeep_abundant()inst/NEWS.rdformula_designandminimum_categoryparametersKey API (from PR #341)
The core motivation: global filtering silently drops features that are strongly expressed in one group but absent in others — exactly the signals targeted by differential testing. Category-aware filtering preserves them.
Original prompt
Update the documentation in
tidyomics/tidybulkto cover the functionality introduced by pull request #341 (https://github.com/tidyomics/tidybulk/pull/341), titled "Keep abundant per category as an alternative filtering method".The goal is to create a documentation-focused pull request that updates the README and relevant vignette(s) so users can discover, understand, and correctly apply this feature.
Requirements:
Please make the documentation thorough and clear, with emphasis on both:
Repository:
tidyomics/tidybulkThe following is the prior conversation context from the user's chat exploration (may be truncated):
User: please update README and vignettes with this functionality documenting it well, and why it is important
Assistant: I can do that, but I can’t directly make the doc changes unless you want me to open a PR.
If your goal is for me to implement the README/vignette updates in the repo, say:
open a PR in tidyomics/tidybulk for PR #341 docsand I’ll create it.
If you want the documentation text first, here’s a polished draft you can use for the README and vignettes.
Suggested documentation update
What changed
Add documentation for a new filtering option that keeps features that are abundant within at least one category, as an alternative to global abundance filtering.
Why this matters
This is important because biologically meaningful signals are often category-specific. A feature may be highly abundant in one group of samples but low or absent elsewhere. Global filtering can remove those features too early, especially in designs involving:
Filtering by abundance per category helps retain features that are informative for downstream differential analyses and visualization, while still removing broadly uninformative low-abundance features.
README text draft
You could add a short section under filtering / preprocessing.
If the actual argument name differs from
.category, I should align the wording to the exact API in PR #341 before finalizing.Vignette section draft
This should be a bit more explanatory and example-driven.