Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 3.05 KB

README.md

File metadata and controls

68 lines (49 loc) · 3.05 KB

scCustomize

GitHub release (latest by date) license issues DOI

scCustomize is a collection of functions created and/or curated to aid in the visualization and analysis of single-cell data using R.

Vignettes/Tutorials

See accompanying scCustomize website for detailed tutorials of all aspects of scCustomize functionality.

Installing scCustomize

scCustomize can be installed from GitHub using either devtools or remotes package. For more detailed instructions see Installation.

devtools::install_github(repo = "samuel-marsh/scCustomize")

remotes::install_github(repo = "samuel-marsh/scCustomize")

If you had previously installed colorway package prior to installing scCustomize please make sure to update to >= v0.2.0.

Master branch
Full releases will be available on the master branch with version scheme vX.X.X.
See NEWS.md file for ChangeLog with additions, changes, and fixes contained in each release.

Develop branch
I also maintain a separate development branch* that can be installed by supplying ref = "develop" in the devtools or remotes installation command. Version scheme vX.X.X.yyyy.
*Note: While this branch is typically mostly stable it may contain breaking issues/bugs.
I do try and keep development ChangeLog up to date so it’s easier to follow changes than reading commit history.

Bug Reports/New Features

If you run into any issues or bugs please submit a GitHub issue with details of the issue.

  • If possible please include a reproducible example (suggest using SeuratData package pbmc dataset for lightweight examples.)

Any requests for new features or enhancements can also be submitted as GitHub issues.

  • Even if you don’t know how to implement/incorporate with current package go ahead a submit!

Pull Requests are welcome for bug fixes, new features, or enhancements.

  • Please set PR to merge with “develop” branch and provide description of what the PR contains (referencing existing issue(s) if appropriate).