-
Notifications
You must be signed in to change notification settings - Fork 53
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomers
Description
Rarefaction is briefly mentioned in Chapter 12.3, but the clearer, practical explanation is only later in Chapter 15. This makes it hard for new users to understand how to use rarefyAssay() (and niter) with addAlpha() and addMDS().
Proposed changes
- Move or duplicate the detailed rarefaction explanation from Chapter 15 into Chapter 12.3 (with cross-refs if duplicated).
- Expand/rename Chapter 12.3 (“Rarefaction” → “Rarefying”?) to include:
- Short rationale for rarefaction vs alternatives.
- How to use
rarefyAssay()withniterfor iterative rarefaction. - Examples using
niterin:addAlpha()(alpha diversity).runMDS()/addMDS()(beta diversity).
- Briefly clarify:
addAlpha()vsgetAlpha()runMDS()vsaddMDS()
(what they do and when to use which).
Example to add (alpha diversity)
min_reads <- min(colSums(assay(tse, "counts")))
tse <- rarefyAssay(
tse,
method = "subsample",
sample = min_reads,
niter = 100
)
tse <- addAlpha(
tse,
assay_name = "counts_rarefied",
sample = min_reads,
niter = 100
)Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomers