Skip to content

Commit d039c96

Browse files
committed
doc: add badges and citation material
1 parent a408d48 commit d039c96

File tree

2 files changed

+18
-27
lines changed

2 files changed

+18
-27
lines changed

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
1+
[![DOI](https://img.shields.io/badge/Bioinformatics-10.1038/10.1093/bioinformatics/btae487x-blue)](https://doi.org/10.1093/bioinformatics/btae487)
2+
[![](https://img.shields.io/badge/lifecycle-stable-green.svg)](https://www.tidyverse.org/lifecycle/#stable)
3+
14
# tidyCoverage
25

36
The `tidyCoverage` R package provides a framework for rapid investigation of collections of genomic tracks over genomic features, relying on the principle of tidy data manipulation. It relies on `CoverageExperiment` and `AggregatedCoverage` classes, directly extending the `SummarizedExperiment` fundamental class,
47

8+
If you are using `tidyCoverage`, please consider citing:
9+
10+
Serizay J, Koszul R (2024). “Epigenomics coverage data extraction and aggregation in R with tidyCoverage.” _Bioinformatics_ *40*, doi:10.1093/bioinformatics/btae487 <https://doi.org/10.1093/bioinformatics/btae487>.
11+
512
## Installation
613

714
In `R >= 4.4` and `Bioconductor >= 3.19`:

inst/CITATION

+11-27
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,13 @@
1-
pkgVer <- function(pkg) {
2-
if (!exists("meta") || is.null(meta)) meta <- packageDescription(pkg)
3-
ver <- meta$Version
4-
paste0('https://github.com//', pkg, ' - R package version ', ver)
5-
}
6-
7-
c(
8-
9-
bibentry(bibtype="manual",
10-
title = "Jacques' Package",
11-
author = personList(
12-
as.person("Jacques")
13-
),
14-
year = format(Sys.Date(), "%Y"),
15-
url = "http://www.bioconductor.org/packages/AggregatedCoverage",
16-
note = pkgVer('AggregatedCoverage'),
17-
doi = '10.18129/B9.bioc.AggregatedCoverage'
1+
bibentry(
2+
bibtype = "Article",
3+
author = c(
4+
person(c("Jacques"), "Serizay"),
5+
person(c("Romain"), "Koszul")
186
),
19-
bibentry(bibtype="article",
20-
title = "Jacques' Package",
21-
author = personList(
22-
as.person("Jacques")
23-
),
24-
year = format(Sys.Date(), "%Y"),
25-
journal = "bioRxiv",
26-
doi = "10.1101/TODO",
27-
url = "https://www.biorxiv.org/content/10.1101/TODO"
28-
)
7+
title = "Epigenomics coverage data extraction and aggregation in R with tidyCoverage",
8+
journal = "Bioinformatics",
9+
year = "2024",
10+
volume = "40",
11+
pages = "btae487",
12+
doi = "10.1093/bioinformatics/btae487"
2913
)

0 commit comments

Comments
 (0)