Skip to content

Commit

Permalink
Add note to requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
Jong-hun-Park committed Nov 7, 2023
1 parent c1dac12 commit ef8d8c1
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ Full documentation is available at [readthedocs](https://trviz.readthedocs.io/)
# Getting Started

## Prerequisite
TRviz requires [MAFFT](https://mafft.cbrc.jp/alignment/software/). Tested with MAFFT v7.505.
> **Note**
> TRviz requires [MAFFT](https://mafft.cbrc.jp/alignment/software/). Tested with MAFFT v7.505.
Install the library with pip or from source.
## with pip
Expand All @@ -34,20 +35,19 @@ pip install .
```

## Input
1. Tandem repeat sequences
1. Tandem repeat sequences (alleles)
2. A set of motifs for decomposition

## Output
1. Motif map, a set of motifs detected in the samples and their labels and frequencies
2. Aligned and labeled motifs
3. A plot showing the motif composition of the input sequences
4. A plot mapping color to motif
1. A plot showing the motif composition of the input sequences
2. A plot mapping color to motif
3. Aligned and labeled motifs
4. Motif map, a set of motifs detected in the samples and their labels and frequencies

# Code samples and examples
> **Note**
> Please see the [jupyter notebook](https://github.com/Jong-hun-Park/trviz/blob/main/examples/sample_code.ipynb) for code examples.

TRviz has four modules:
1. Decomposition
2. Encoding
Expand Down

0 comments on commit ef8d8c1

Please sign in to comment.