Skip to content

Commit

Permalink
adds license badge and readme details for coverage and style checks
Browse files Browse the repository at this point in the history
  • Loading branch information
bwlang committed Feb 10, 2024
1 parent a903043 commit b9a2d74
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ It is intended to differentiate between ARTIC v3, ARTIC v4, ARTIC v4.1, VarSkip
## This program is not yet fully tested, it's shared now to enable commentary from the scientific community.

![Tests](https://github.com/nebiolabs/ampseer/workflows/Tests/badge.svg)
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)

Pull requests and issues are welcome.

Expand All @@ -20,7 +21,7 @@ samtools fastq tests/fixtures/vss2_large.bam 3.55s user 0.11s system 99% cpu 3.
target/release/ampseer --reads /dev/stdin --primer-sets primer_sets/*.fasta 3.40s user 0.09s system 95% cpu 3.661 total
```

Note: Ampseer will produce "unknown" unless one primer set can be clearly separated from other candidates. It will not be able to identify differences between related sets unless both candidate sets are included. For example, ampseer will identify a ARTIC v4.1 library as ARTIC v4 unless both primer sets are included as candidates.
Note: Ampseer will produce "unknown" unless one primer set can be clearly separated from other candidates. It will not be able to identify differences between related sets unless both candidate sets are included. For example, ampseer will identify n ARTIC v4.1 library as ARTIC v4 unless both primer sets are included as candidates.

## Example Commands:
This tool does not yet have any binary releases. To try it, you will need to [install rustup](https://www.rust-lang.org/tools/install), or `rustup update` if you are using an older rust installation.
Expand All @@ -34,13 +35,25 @@ samtools fastq tests/fixtures/vss2_small.bam \
```
### view ampseer help:
```sh
cargo build --release # may take some time to compile the first time
cargo build --release
target/release/ampseer -h
```

### run the tests:
```sh
cargo test # may take some time to compile the first time
cargo test
```
### code style checking:
```sh
cargo clippy
```
### evaluate code coverage via html:
```sh
cargo llvm-cov --open
```
### evaluate code coverage in vscode:
```sh
cargo llvm-cov --lcov --output-path lcov.info
```

### make a flamegraph (--root needed on MacOS):
Expand Down

0 comments on commit b9a2d74

Please sign in to comment.