Skip to content

Commit 302c74f

Browse files
committed
[DOC] Update README badges
1 parent 51f863b commit 302c74f

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,36 @@
22

33
### A fast and space-efficient pre-filter for estimating the quantification of very large collections of nucleotide sequences
44

5-
[![Build Status](https://github.com/seqan/app-template/workflows/App%20CI/badge.svg)](https://github.com/seqan/needle/actions?query=branch%3Amaster+workflow%3A%22App+CI%22) [![codecov](https://codecov.io/gh/seqan/needle/branch/master/graph/badge.svg?token=SJVMYRUKW2)](https://codecov.io/gh/seqan/needle) [![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](#install-with-bioconda-linux)
5+
[![build status][1]][2]
6+
[![codecov][3]][4]
7+
[![license][5]][6]
8+
![platforms][7]
9+
<!-- [![latest release][7]][8] -->
10+
11+
<!--
12+
Above uses reference-style links with numbers.
13+
See also https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#links.
14+
15+
For example, `[![build status][1]][2]` evaluates to the following:
16+
`[link_text][2]`
17+
`[2]` is a reference to a link, i.e. `[link_text](https://...)`
18+
19+
`[link_text]` = `[![build status][1]]`
20+
`[1]` is once again a reference to a link - this time an image, i.e. `[![build status](https://...)]
21+
`![build status]` is the text that should be displayed if the linked resource (`[1]`) is not available
22+
23+
`[![build status][1]][2]` hence means:
24+
Show the picture linked under `[1]`. In case it cannot be displayed, show the text "build status" instead.
25+
The picture, or alternative text, should link to `[2]`.
26+
-->
27+
28+
[1]: https://img.shields.io/github/actions/workflow/status/seqan/needle/ci_linux.yml?branch=main&style=flat&logo=github&label=CI "Open GitHub actions page"
29+
[2]: https://github.com/seqan/needle/actions?query=branch%3Amain
30+
[3]: https://codecov.io/gh/seqan/needle/graph/badge.svg?token=W109QS58E0 "Open Codecov page"
31+
[4]: https://codecov.io/gh/seqan/needle
32+
[5]: https://img.shields.io/badge/license-BSD-green.svg "Open Copyright page"
33+
[6]: https://github.com/seqan/needle/blob/main/LICENSE.md
34+
[7]: https://img.shields.io/badge/platform-linux%20%7C%20bsd%20%7C%20osx-informational.svg
635

736
Needle is a tool for semi-quantitative analysis of very large collections of nucleotide sequences.
837
Needle stores its data in multiple interleaved Bloom filter, a fast and space efficient probabilistic data structure and uses a windowing scheme (also called minimisers) to reduce the amount of data to store. How many interleaved Bloom filter are used is defined by the user. Each interleaved Bloom filter has a so called expression threshold and stores minimisers with an occurrence greater than or equal to its own expression threshold and smaller than the next biggest expression threshold (if there is no bigger expression threshold, all greater than or equal to the threshold are stored). These expression thresholds are then used during the query (called estimate) to approximate the expression values of given transcripts.

0 commit comments

Comments
 (0)