File: README.md

package info (click to toggle)
python-pyspoa 0.2.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 156 kB
  • sloc: python: 148; sh: 65; makefile: 37; cpp: 35
file content (47 lines) | stat: -rw-r--r-- 1,620 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# pyspoa

![test-pyspoa](https://github.com/nanoporetech/pyspoa/workflows/test-pyspoa/badge.svg) [![PyPI version](https://badge.fury.io/py/pyspoa.svg)](https://badge.fury.io/py/pyspoa)

Python bindings to [spoa](https://github.com/rvaser/spoa).

## Installation

```bash
$ pip install pyspoa
```

## Usage

```python
>>> from spoa import poa
>>>
>>> consensus, msa = poa(['AACTTATA', 'AACTTATG', 'AACTATA'])
>>> consensus
'AACTTATA'
>>> msa
['AACTTATA-', 'AACTTAT-G', 'AAC-TATA-']
>>> print(os.linesep.join(msa))
AACTTATA-
AACTTAT-G
AAC-TATA-
```

## Developer Quick Start

```bash
$ git clone --recursive https://github.com/nanoporetech/pyspoa.git
$ cd pyspoa
$ python3 -m venv pyspoa
$ source pyspoa/bin/activate
(pyspoa) $ make build
```

### Licence and Copyright
(c) 2019 Oxford Nanopore Technologies Ltd.

pyspoa is distributed under the terms of the MIT License.  If a copy of the License
was not distributed with this file, You can obtain one at https://github.com/nanoporetech/pyspoa

### Research Release

Research releases are provided as technology demonstrators to provide early access to features or stimulate Community development of tools. Support for this software will be minimal and is only provided directly by the developers. Feature requests, improvements, and discussions are welcome and can be implemented by forking and pull requests. However much as we would like to rectify every issue and piece of feedback users may have, the developers may have limited resource for support of this software. Research releases may be unstable and subject to rapid iteration by Oxford Nanopore Technologies.