similaRpeak : metrics to estimate the level of similarity between two ChIP profiles.
=====================

[![R-CMD-check-bioc](https://github.com/adeschen/similaRpeak/actions/workflows/check-bioc.yaml/badge.svg)](https://github.com/adeschen/similaRpeak/actions/workflows/check-bioc.yaml)
[![codecov](https://codecov.io/gh/adeschen/similaRpeak/branch/master/graph/badge.svg)](https://codecov.io/gh/adeschen/similaRpeak)
[![License: Artistic-2.0](https://img.shields.io/badge/License-Artistic%202.0-0298c3.svg)](https://opensource.org/licenses/Artistic-2.0)


This package calculates metrics to estimate a level of similarity between two 
ChIP-Seq profiles.

## Bioconductor Package ##

[![Bioconductor Time](http://bioconductor.org/shields/years-in-bioc/similaRpeak.svg)](http://bioconductor.org/packages/release/bioc/html/similaRpeak.html "Bioconductor status")

similaRpeak is now an official package of [Bioconductor](http://bioconductor.org/). The current release can be directly downloaded from their website:
[Current release](http://bioconductor.org/packages/release/bioc/html/similaRpeak.html)

However, all official releases can be downloaded from this site:
[All releases](https://github.com/adeschen/similaRpeak/releases)


## Note ##

To use this current similaRpeak version, the use of the R6 package (>= 2.0) is mandatory.


## Authors ##

[Astrid Desch&ecirc;nes](http://ca.linkedin.com/in/astriddeschenes "Astrid Desch&ecirc;nes"), 
Elsa Bernatchez, 
[Charles Joly Beauparlant](http://ca.linkedin.com/pub/charles-joly-beauparlant/89/491/3b3 "Charles Joly Beauparlant"), 
[Fabien Claude Lamaze](http://ca.linkedin.com/in/fabienlamaze/en "Fabien Claude Lamaze"), 
[Rawane Samb](http://ca.linkedin.com/in/rawanesamb "Rawane Samb"), 
[Pascal Belleau](http://ca.linkedin.com/in/pascalbelleau "Pascal Belleau") 
and [Arnaud Droit](http://ca.linkedin.com/in/drarnaud "Arnaud Droit").

## Maintainer ##

[Astrid Desch&ecirc;nes](http://ca.linkedin.com/in/astriddeschenes "Astrid Desch&ecirc;nes")

## License ##

This package and the underlying similaRpeak code are distributed under the 
Artistic license 2.0. You are free to use and redistribute this software. 

For more information on Artistic 2.0 License see
[http://opensource.org/licenses/Artistic-2.0](http://opensource.org/licenses/Artistic-2.0)

## Bugs/Feature requests ##

If you have any bugs or feature requests, 
[let us know](https://github.com/adeschen/similaRpeak/issues). 

Thanks!

