Skip to content

feat: enhance splikit with multi-threading, memory management, and do…#17

Merged
Arshammik merged 5 commits intomainfrom
version_2
Aug 10, 2025
Merged

feat: enhance splikit with multi-threading, memory management, and do…#17
Arshammik merged 5 commits intomainfrom
version_2

Conversation

@Arshammik
Copy link
Copy Markdown
Collaborator

…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

…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
- 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.
@Arshammik Arshammik merged commit b070eb5 into main Aug 10, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Join results in more than 2^31 rows

1 participant