Skip to content

Commit

Permalink
Remove to_pdf because the dependencies of weasyprint are complex,…
Browse files Browse the repository at this point in the history
… and installation fails on macOS. I would like to leave the saving of HTML to PDF to the browser's functionality.
  • Loading branch information
akikuno authored Jul 28, 2024
1 parent 4996d99 commit 830078d
Showing 1 changed file with 0 additions and 17 deletions.
17 changes: 0 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
- `cstag.to_sequence()`: Reconstruct a reference subsequence from the alignment
- `cstag.to_vcf()`: Generate a VCF representation
- `cstag.to_html()`: Generate an HTML representation
- `cstag.to_pdf()`: Produce a PDF file

For comprehensive documentation, please visit [our docs](https://akikuno.github.io/cstag/cstag/).

Expand Down Expand Up @@ -193,22 +192,6 @@ You can visualize mutations indicated by the cs tag using the generated `report.
<img width="511" alt="image" src="https://user-images.githubusercontent.com/15861316/265405607-a3cc1b76-f6a2-441d-b282-6f2dc06fc03d.png">


### Generating a PDF Report

```python
import cstag

cs_tag = "=AC+ggg=T-acgt*at~gt10ag=GNNN"
description = "Example"
path_out = "report.pdf"

cstag.to_pdf(cs_tag, description, path_out)
# Output "report.pdf"
```

You can obtain the same images of `cstag.to_html` as a PDF file.


## 📣 Feedback and Support

For questions, bug reports, or other forms of feedback, we'd love to hear from you!
Expand Down

0 comments on commit 830078d

Please sign in to comment.