README.md

In AllenInstitute/scrattch.hicat: Hierarchical Iterative Clustering Analysis for Transcriptomic data

scrattch.hicat: Hierarchical, Iterative Clustering for Analysis of Transcriptomics

Master:

Dev:

Installation

scrattch.hicat has several dependencies, including two from BioConductor and one from Github:

if (!require("BiocManager", quietly = TRUE))
    install.packages("BiocManager")
BiocManager::install("limma")

devtools::install_github("JinmiaoChenLab/Rphenograph")

Once these dependencies are installed, scrattch.hicat can be installed with:

devtools::install_github("AllenInstitute/scrattch.hicat")

Vignettes

An overview of the main functions in scrattch.hicat

Tutorials

An interactive walkthrough of the major steps in clustering for scrattch.hicat.

Roadmap

The next few updates to scrattch.hicat will be aimed at getting code testing in place for major clustering functions: 0.0.22: Current version; Tests in place for de.genes.R functions. 0.0.23: Tests in place for cluster.R functions. 0.1.0: Vignette re-integrated; Adding pkgdown page; Update to Master branch.

Previous updates: 0.0.21: Added TravisCI and covr integration.

The scrattch suite

scrattch.hicat is one component of the scrattch suite of packages for Single Cell RNA-seq Analysis for Transcriptomic Type CHaracterization from the Allen Institute.

License

The license for this package is available on Github at: https://github.com/AllenInstitute/scrattch.hicat/blob/master/LICENSE

Level of Support

We are planning on occasional updating this tool with no fixed schedule. Community involvement is encouraged through both issues and pull requests.

Contribution Agreement

If you contribute code to this repository through pull requests or other mechanisms, you are subject to the Allen Institute Contribution Agreement, which is available in full at: https://github.com/AllenInstitute/scrattch.hicat/blob/master/CONTRIBUTION

Image attribution:

By Internet Archive Book Images [No restrictions], via Wikimedia Commons

AllenInstitute/scrattch.hicat documentation built on Oct. 20, 2023, 6:55 a.m.