{"id":13763645,"url":"https://github.com/GreenleafLab/chromVAR","last_synced_at":"2025-05-10T17:30:50.216Z","repository":{"id":39545274,"uuid":"46593640","full_name":"GreenleafLab/chromVAR","owner":"GreenleafLab","description":"chromatin Variability Across Regions (of the genome!)","archived":false,"fork":false,"pushed_at":"2024-07-10T20:48:05.000Z","size":19715,"stargazers_count":158,"open_issues_count":78,"forks_count":38,"subscribers_count":21,"default_branch":"master","last_synced_at":"2024-10-31T07:27:45.263Z","etag":null,"topics":["atac-seq","bioinformatics","dnase-seq","r"],"latest_commit_sha":null,"homepage":"https://greenleaflab.github.io/chromVAR/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GreenleafLab.png","metadata":{"files":{"readme":"README.md","changelog":"NEWS","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-11-21T00:04:25.000Z","updated_at":"2024-10-30T00:21:39.000Z","dependencies_parsed_at":"2024-08-03T15:02:20.863Z","dependency_job_id":"01c5a329-f1f6-4aff-8cec-26a6844f4edb","html_url":"https://github.com/GreenleafLab/chromVAR","commit_stats":{"total_commits":271,"total_committers":9,"mean_commits":30.11111111111111,"dds":"0.16605166051660514","last_synced_commit":"0f27fcc8463d537d770f164a55f949701beb6add"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GreenleafLab%2FchromVAR","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GreenleafLab%2FchromVAR/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GreenleafLab%2FchromVAR/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GreenleafLab%2FchromVAR/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GreenleafLab","download_url":"https://codeload.github.com/GreenleafLab/chromVAR/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253453191,"owners_count":21911054,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["atac-seq","bioinformatics","dnase-seq","r"],"created_at":"2024-08-03T15:00:54.643Z","updated_at":"2025-05-10T17:30:49.516Z","avatar_url":"https://github.com/GreenleafLab.png","language":"R","funding_links":[],"categories":["Single-cell"],"sub_categories":[],"readme":"---\n[![Build Status](https://travis-ci.org/GreenleafLab/chromVAR.svg?branch=master)](https://travis-ci.org/GreenleafLab/chromVAR)\n\n# chromVAR\n\nchromVAR is an R package for the analysis of sparse chromatin accessibility data from single cell or bulk ATAC or DNAse-seq data. The package aims to identify motifs or other genomic annotations associated with variability in chromatin accessibility between individual cells or samples.  For a more detail overview of the method, please see the [publication](https://www.nature.com/nmeth/journal/vaop/ncurrent/full/nmeth.4401.html) ([pdf](http://greenleaf.stanford.edu/assets/pdf/nmeth.4401.pdf), [supplement](https://drive.google.com/file/d/0B8eUn6ZURmqvUjBCbE5Hc0p4UFU/view?usp=sharing)). \n\nFor a paper evaluating chromVAR and other methods as a method for enabling clustering of single cells, see [the preprint from Huidong Chen et al](https://www.biorxiv.org/content/10.1101/739011v1). Using kmers + PCA appears to be the best variant of chromVAR for clustering, but newer methods such as [SnapATAC](https://github.com/r3fang/SnapATAC) outperform chromVAR for the clustering tasks evaluated in the paper. chromVAR may be complementary to some other methods, as a way of annotating TF motif usage in cells \u0026 clusters rather than cluster identification or embedding.\n\n## Installation\n\nThe recommended installation method for `chromVAR` is using BiocManager. You will first have to have installed the [BiocManager package\n](https://cran.r-project.org/package=BiocManager).\n\n```r\nif (!requireNamespace(\"BiocManager\", quietly = TRUE))\n    install.packages(\"BiocManager\")\nBiocManager::install(\"chromVAR\")\n```\n\nA number of needed packages are installed in this process. One of the dependencies has a system requirement for the gsl library, so if this is not installed already it may need to be installed separately. Several people have reported issues with the GO.db package (a dependency of one of the dependencies) not being installed automatically -- if you see an error relating to that package, try installing it separately first (`BiocManager::install(\"GO.db\")`).\n\nFor Windows users, some have reported that the S4Vector dependency does not currently function on windows R 3.3.3, but that installation was successful on R 3.3.2.\n\nFor Mac users, some have encountered installation difficulties relating to compiling the C++ code. If you encounter problems, please see the threads and advice in Issues [11](https://github.com/GreenleafLab/chromVAR/issues/11) and [20](https://github.com/GreenleafLab/chromVAR/issues/20).  \n\nTwo additional packages that are recommended and used in the vignettes:\n\n* motifmatchr - available on [GitHub](https://github.com/GreenleafLab/motifmatchr) or [development version of Bioconductor](https://bioconductor.org/packages/devel/bioc/html/motifmatchr.html)\n* JASPAR2016  - available from Bioconductor\n\nAdditionally, the package chromVARmotifs can be useful for loading additional motif collections:\n\n* chromVARmotifs -  available on [GitHub](https://github.com/GreenleafLab/chromVARmotifs)\n\n## Parallelization\n\nBefore running chromVAR functions, it is advisable to use the `register` function from BiocParallel to specify your preferred method of parallelization.  For unix systems, \n\n```r\nlibrary(BiocParallel)\nregister(MulticoreParam(8)) # Use 8 cores\n```\n\nFor Windows, `MulticoreParam` will not work, but you can use SnowParam:\n\n```r\nregister(SnowParam(SnowParam(workers=1, type = \"SOCK\")))\n```\n\nEven if you don't want to use more than one core, it is recommended to explicitly register that choice using SerialParam:\n\n```r\nregister(SerialParam())\n```\n\nPlease see the documentation for [BiocParallel](https://bioconductor.org/packages/release/bioc/html/BiocParallel.html) for more information about the `register` function and the various options for multi-processing. \n\n\n## Quickstart\n\n``` r\nlibrary(chromVAR)\nlibrary(motifmatchr)\nlibrary(BSgenome.Hsapiens.UCSC.hg19)\n\n### Example of how to read in counts -------------------------------------------\n\n# Caution: FAKE FILENAMES -- Replace with real as appropriate! If you want to \n# run on example data in package, start at next section with example_counts data\n\npeakfile \u003c- \"mypeaks.bed\"\npeaks \u003c- getPeaks(peakfile)\n\nbamfiles \u003c- c(\"mybam1.bam\",\"mybam2.bam\")\nfragment_counts \u003c- getCounts(bamfiles, peaks, \n                              paired =  TRUE, \n                              by_rg = TRUE, \n                              format = \"bam\", \n                              colData = DataFrame(celltype = c(\"GM\",\"K562\")))\n\n### ----------------------------------------------------------------------------\n\n### Using example counts from package ------------------------------------------\n\ndata(example_counts, package = \"chromVAR\")\nexample_counts \u003c- addGCBias(example_counts, \n                              genome = BSgenome.Hsapiens.UCSC.hg19)\ncounts_filtered \u003c- filterSamples(example_counts, min_depth = 1500,\n                                  min_in_peaks = 0.15)\ncounts_filtered \u003c- filterPeaks(counts_filtered)\nmotifs \u003c- getJasparMotifs()\nmotif_ix \u003c- matchMotifs(motifs, counts_filtered,\n                         genome = BSgenome.Hsapiens.UCSC.hg19)\n\n# computing deviations\ndev \u003c- computeDeviations(object = counts_filtered, \n                                 annotations = motif_ix)\n\n```\n\nSee [documentation website](https://greenleaflab.github.io/chromVAR/) for more information!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGreenleafLab%2FchromVAR","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FGreenleafLab%2FchromVAR","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGreenleafLab%2FchromVAR/lists"}