File: README.md

package info (click to toggle)
yanosim 0.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 100 kB
  • sloc: python: 493; sh: 20; makefile: 3
file content (66 lines) | stat: -rwxr-xr-x 1,714 bytes parent folder | download | duplicates (2)
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# Yanosim (yet another nanopore simulator)

Read simulator for nanopore DRS datasets.

## Installation:

`pip install git+git://github.com/bartongroup/yanosim`

## Usage:

### `model`:

```
$ yanosim model --help
Usage: yanosim model [OPTIONS]

  Creates an model of mismatches, insertions and deletions based on an
  alignment of nanopore DRS reads to a reference. Reads should be aligned to
  a transcriptome i.e. without spliced alignment, using minimap2. They
  should have the cs tag.

Options:
  -b, --bam-fn TEXT        [required]
  -o, --output-fn TEXT     [required]
  -p, --processes INTEGER
  --help                   Show this message and exit.
```

### `quantify`:

```
$ yanosim quantify --help
Usage: yanosim quantify [OPTIONS]

  Quantify the number of reads mapping to each transcript in a reference, so
  that the right number of reads can be simulated.

Options:
  -b, --bam-fn TEXT               [required]
  -o, --output-fn TEXT            [required]
  -g, --gtf-fn TEXT
  -f, --filtered-gtf-output-fn TEXT
  -r, --remove-ensembl-version
  --help                          Show this message and exit.
```

### `simulate`:

```
$ yanosim simulate --help
Usage: yanosim simulate [OPTIONS]

  Given a model created using yanosim model, and per-transcript read counts
  created using yanosim simulate, simulate error-prone long-reads from the
  given fasta file.

Options:
  -f, --fasta-fn TEXT             [required]
  -m, --model-fn TEXT             [required]
  -q, --quantification-fn TEXT    [required]
  -o, --output-fn TEXT            [required]
  --model-frag / --no-model-frag
  -p, --processes INTEGER
  -s, --seed INTEGER
  --help                          Show this message and exit.
```