Skip to content

Commit

Permalink
DOC: Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Vini2 committed Nov 26, 2022
1 parent 4370e7d commit e7f2b73
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Setting up Phables

Phables is now available on PyPI at [https://pypi.org/project/phables/](https://pypi.org/project/phables/). If you directly installed Phables from [PyPI](https://pypi.org/project/phables/), you can skip the next two steps and go to [Setting up Gurobi](#setting-up-gurobi).

## Downloading Phables

You can clone the Phables repository to your machine.
Expand Down
6 changes: 6 additions & 0 deletions docs/preprocess.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ The `assembly_graph.gfa` file contains the unitig sequences which should be extr

```bash
python gfa2fasta.py --graph assembly_graph.gfa --assembler flye --output <output_folder>

# If you installed using pip
gfa2fasta --graph assembly_graph.gfa --assembler flye --output <output_folder>
```

## Step 3: Map reads to unitig sequences and get BAM files
Expand Down Expand Up @@ -59,6 +62,9 @@ This command will produce a coverage file for each sample. You can combine the c

```bash
python combine_cov.py --covpath coverage_rpkm --output <output_path>

# If you installed using pip
combine_cov --covpath coverage_rpkm --output <output_path>
```

The output file will be `coverage.tsv` where each row represents a unitig and each column represents a sample.
Expand Down

0 comments on commit e7f2b73

Please sign in to comment.