Skip to content

Commit

Permalink
skip-ci,docs: Update README.md
Browse files Browse the repository at this point in the history
Add learn/apply details to README
  • Loading branch information
christinehc committed Dec 19, 2023
1 parent 94a1374 commit 155e36c
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ to determine probabilistic annotations.
<img align="center" src="resources/snekmer_workflow.svg">
</p>

There are three operation modes for Snekmer: `cluster`, `model`, and `search`.
There are 5 operation modes for Snekmer: `cluster`, `model`, `search`, `learn`, and `apply`.

**Cluster mode:** The user supplies files containing sequences in an appropriate format (e.g. FASTA).
Snekmer applies the relevant workflow steps and outputs the resulting clustering results in tabular form (.CSV),
Expand All @@ -30,6 +30,16 @@ displays K-fold cross validation results in the form of figures (AUC ROC and PR
and the models they wish to search their sequences against. Snekmer applies the relevant workflow steps
and outputs a table for each file containing model annotation probabilities for the given sequences.

**Learn mode:** The user supplies files containing sequences in an appropriate format (e.g. FASTA)
as well as an annotation file. Snekmer generates a kmer counts matrix with the summed kmer distribution
of each annotation recognized from the sequence ID. Snekmer then performs a self-evaluation to assess
confidence levels. There are two outputs, a counts matrix, and a global confidence distribution.

**Apply mode:** The user supplies files containing sequences in an appropriate format (e.g. FASTA)
and the outputs received from Learn. Snekmer uses cosine distance to predict the annotation of each
sequence from the kmer counts matrix. The output is a table for each file containing sequence annotation
predictions with confidence levels.

## How to Use Snekmer

For installation instructions, documentation, and more, refer to
Expand Down

0 comments on commit 155e36c

Please sign in to comment.