[r] add print method for dim reductions#115
Merged
immanuelazn merged 2 commits intoia/lsi-iterativefrom Apr 15, 2025
Merged
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.
User description
Check out reference pages for
IterativeLSI()andLSI()to have a better clue of what these look like.I took a generally simple approach for a print method, and am only providing cell embedding sizes, feature names, and param names in
fitted_params. Styling is relatively similar to what was provided withIterableMatrixandIterableFragmentobjects. I tried to do some wrapping so each line only outputs 5 objects at a time. I might replace this with thetibble::str_wrap()method since it seems to be a little bit more elegant.PR Type
Enhancement, Documentation
Description
Added a
printmethod forDimReductionobjects.Enhanced examples in
LSIandIterativeLSIdocumentation.Updated namespace to include
print.DimReductionS3 method.Changes walkthrough 📝
NAMESPACE
Register `print.DimReduction` in namespace.r/NAMESPACE
print.DimReductionas an S3 method.singlecell_utils.R
Add `print.DimReduction` method for formatted output.r/R/singlecell_utils.R
print.DimReductionmethod for better object display.IterativeLSI.Rd
Update `IterativeLSI` documentation with examples.r/man/IterativeLSI.Rd
dim_reductionoutput display.LSI.Rd
Update `LSI` documentation with examples.r/man/LSI.Rd
lsi_resultoutput display.