Giter VIP home page Giter VIP logo

cellspace's Introduction

CellSpace

CellSpace is a sequence-informed embedding method for scATAC-seq that learns a mapping of DNA k-mers and cells to the same space.

See our pre-print for more details.

Installation and Usage

  1. Compile the C++ program to use as a command line tool to train a CellSpace model.

CellSpace, which uses the C++ implementation of StarSpace [Wu et al., 2017], builds on modern Mac OS and Linux distributions. It requires a compiler with C++11 support and a working make.

Install Boost library and specify the path of the library in the makefile (set variable BOOST_DIR). The default path will work if you install Boost by:

wget https://boostorg.jfrog.io/artifactory/main/release/1.63.0/source/boost_1_63_0.zip
unzip boost_1\_63_0.zip
sudo mv boost_1\_63_0 /usr/local/bin

Download and build CellSpace:

git clone https://github.com/zakieh-tayyebi/CellSpace.git
cd CellSpace/cpp/
make
export PATH=$(pwd):$PATH

Verify that it was successfully compiled:

CellSpace --help
  1. Install the R package to use the trained CellSpace model for downstream analysis.

Run the following commands in R:

install.packages("devtools")
devtools::install_github("https://github.com/zakieh-tayyebi/CellSpace.git")
library(CellSpace)

Installation should take only a few minutes. For details about the R functions, please refer to the API.

  1. A tutorial on CellSpace usage can be found here.

Citation

Please cite the arXiv paper if you use CellSpace:

Tayyebi, Z., Pine, A. R., & Leslie, C. S. (2023). Scalable sequence-informed embedding of single-cell ATAC-seq data with CellSpace. BioRxiv. https://doi.org/10.1101/2022.05.02.490310

Contact

cellspace's People

Contributors

zakieh-tayyebi avatar pty0111 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.