Skip to content

Commit

Permalink
Merge pull request #594 from Overcraft90/patch-1
Browse files Browse the repository at this point in the history
Update README.md [skip ci]
  • Loading branch information
AndreaGuarracino authored Oct 29, 2024
2 parents 237fc1b + e5a0590 commit a7b31f0
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,31 @@ docker run odgi
An alternative way to manage `odgi`'s dependencies is by using the `GNU GUIX` package manager. We use Guix to develop, test and deploy odgi on our systems.
For more information see [INSTALL](./INSTALL.md).

## FAQs

`odgi` is supported by default by [`PGGB`](https://github.com/pangenome/pggb). However, it cannot be run out-of-the-box with [`minigraph-CACTUS`](https://github.com/ComparativeGenomicsToolkit/cactus/blob/master/doc/pangenome.md) pangenomes; this requires few steps for the conversion from GFA v1.1 to GFA v1.0 — which is the one used by `odgi`. The main difference between the two is whether or not including a W field to encode walks in the pangenome graph, a feature that is not as yet supported in `odgi`; hence why `minigraph-CACTUS` has to go through the following conversion step:

```
vg convert -W -t <n_of_threads> -g <pangenome_v1.1>.gfa -f > <pangenome_v1.0>.gfa
```

After converting the `minigraph-CACTUS` graph in GFA v1.0 format; it is then possible to do all conventional `odgi` analyses. For instance:

```
odgi build -g <pangenome_v1.0>.gfa -o <graph>.og -s -O -t <n_of_threads>
```

which is often useful to speed up `odgi` operations using its native format, especially when integrated into pipelines or called multiple times. Afterwards, paths can be extracted with `odgi paths`

```
odgi paths -i <graph.og> -L -t <n_of_threads> | cut -f 1,2 -d '#' | sort | uniq > <prefixes>.tsv
```

and, lasty, any 1D visualization or 2D layout can be produced also for this graph. Below, an example of a 1D viz that colors haplotypes based on their ID:

```
odgi viz -i <graph>.og -o <graph_viz>.png -s # -M <prefixes>.tsv -t <n_of_threads>
```

## documentation

Expand Down

0 comments on commit a7b31f0

Please sign in to comment.