Skip to content

Commit

Permalink
Minor edits in README
Browse files Browse the repository at this point in the history
  • Loading branch information
jkanche committed Oct 25, 2024
1 parent 120dbec commit c8e0d7c
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,15 @@

Parse and construct Python representations for datasets stored in RDS files. `rds2py` supports various base classes from R, and Bioconductor's `SummarizedExperiment` and `SingleCellExperiment` S4 classes. ***For more details, check out [rds2cpp library](https://github.com/LTLA/rds2cpp).***

> **Important Version Notice**
>
> Version 0.5.0 brings major changes to the package:
> - Complete overhaul of the codebase using pybind11
> - Streamlined readers for R data types
> - Updated API for all classes and methods
>
> Please refer to the [documentation](https://biocpy.github.io/rds2py/) for the latest usage guidelines. Previous versions may have incompatible APIs.
---
**Version 0.5.0** brings major changes to the package,
- Complete overhaul of the codebase using pybind11
- Streamlined readers for R data types
- Updated API for all classes and methods

Please refer to the [documentation](https://biocpy.github.io/rds2py/) for the latest usage guidelines. Previous versions may have incompatible APIs.

---

The package provides:

Expand Down Expand Up @@ -77,7 +78,7 @@ data = parse_rds("path/to/file.rds")
print(data)
```

if you know this RDS file contains an `GenomicRanges` object, you can use or modify the provided list reader, or write your own parser to convert this dictionary.
if you know this RDS file contains an `GenomicRanges` object, you can use the built-in reader or write your own reader to convert this dictionary.

```python
from rds2py.read_granges import read_genomic_ranges
Expand Down

0 comments on commit c8e0d7c

Please sign in to comment.