Conversation
…cumentation (closes #16) Major enhancements and fixes: Performance Improvements: - Add multi-threading support for find_variable_genes with sum_deviance method - Implement intelligent memory management in make_m2() with batched processing - Add parallel processing capabilities for large-scale junction data Function Enhancements: - make_junction_ab: Add verbose logging and multi-mapped junction filtering options - make_m1: Add min_counts filtering and verbose parameters - make_m2: Add batch_size, memory_threshold, force_fast, and multi_thread parameters - find_variable_genes: Add n_threads parameter for parallel processing - get_pseudo_correlation: Add metric selection (Cox-Snell/Nagelkerke) and sparse matrix support Documentation Updates: - Fix non-ASCII characters in verbose output (replaced with ASCII alternatives) - Update all Roxygen2 documentation for modified functions - Sync docs/README.md with all recent parameter changes - Add comprehensive examples and parameter descriptions Infrastructure: - Add pkgdown configuration with minimal theme - Add GitHub Actions workflow for automatic site building - Update version to 1.0.5 - Update .Rbuildignore to exclude pkgdown files This release significantly improves performance for large datasets while maintaining backward compatibility and adding comprehensive documentation. Fixes #16
… of the function `make_m2`
- Move manual documentation from docs/ to vignettes/ (standard R package location) * docs/README.md → vignettes/splikit-manual.md * docs/STARsolo.md → vignettes/STARsolo-guide.md - Update README.md links to point to new vignettes location - Update pkgdown.yml to include vignettes as articles - Leave docs/ folder empty for pkgdown to generate site This fixes the GitHub Actions pkgdown build error where it couldn't clean the docs folder due to non-pkgdown content.
- Quote vignette names in _pkgdown.yml to prevent parsing errors - Upgrade to Bootstrap 5 (Bootstrap 3 is deprecated) - Add URL and BugReports fields to DESCRIPTION - Add proper YAML headers to vignettes for pkgdown processing * splikit-manual.md: Added vignette metadata * STARsolo-guide.md: Added vignette metadata These changes ensure pkgdown can properly build the documentation site on GitHub Actions.
- Remove articles section from _pkgdown.yml (causing parsing errors) - Rename vignettes to use underscores instead of hyphens * splikit-manual.md → splikit_manual.Rmd * STARsolo-guide.md → STARsolo_guide.Rmd - Update README.md links to match new vignette names - Simplify pkgdown build to focus on reference documentation The vignettes are preserved for future use but won't block the pkgdown site from building. They can be added back once we determine the correct format for pkgdown articles.
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.
…cumentation (closes #16)
Major enhancements and fixes:
Performance Improvements:
Function Enhancements:
Documentation Updates:
Infrastructure:
This release significantly improves performance for large datasets while maintaining backward compatibility and adding comprehensive documentation.
Fixes #16