Skip to content

Commit 2c84a1a

Browse files
committed
Minor edits to readme
1 parent c8f07de commit 2c84a1a

File tree

1 file changed

+8
-23
lines changed

1 file changed

+8
-23
lines changed

README.md

Lines changed: 8 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -16,28 +16,6 @@ Parse and construct Python representations for datasets stored in RDS files. `rd
1616

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

19-
---
20-
21-
The package provides:
22-
23-
- Efficient parsing of RDS files with _minimal_ memory overhead
24-
- Support for R's basic data types and complex S4 objects
25-
- Vectors (numeric, character, logical)
26-
- Factors
27-
- Data frames
28-
- Matrices (dense and sparse)
29-
- Run-length encoded vectors (Rle)
30-
- Conversion to appropriate Python/NumPy/SciPy data structures
31-
- dgCMatrix (sparse column matrix)
32-
- dgRMatrix (sparse row matrix)
33-
- dgTMatrix (sparse triplet matrix)
34-
- Preservation of metadata and attributes from R objects
35-
- Integration with BiocPy ecosystem for Bioconductor classes
36-
- SummarizedExperiment
37-
- RangedSummarizedExperiment
38-
- SingleCellExperiment
39-
- GenomicRanges
40-
- MultiAssayExperiment
4119

4220
## Installation
4321

@@ -63,7 +41,7 @@ r_obj = read_rds("path/to/file.rds")
6341

6442
The returned `r_obj` either returns an appropriate Python class if a parser is already implemented or returns the dictionary containing the data from the RDS file.
6543

66-
In addition, the package provides the dictionary representation of the RDS file.
44+
To just get the parsed dictionary representation of the RDS file,
6745

6846
```python
6947
from rds2py import parse_rds
@@ -106,6 +84,13 @@ print(gr)
10684
| dgCMatrix | scipy.sparse.csc_matrix |
10785
| dgRMatrix | scipy.sparse.csr_matrix |
10886

87+
and integration with BiocPy ecosystem for Bioconductor classes
88+
- SummarizedExperiment
89+
- RangedSummarizedExperiment
90+
- SingleCellExperiment
91+
- GenomicRanges
92+
- MultiAssayExperiment
93+
10994
## Developer Notes
11095

11196
This project uses pybind11 to provide bindings to the rds2cpp library. Please make sure necessary C++ compiler is installed on your system.

0 commit comments

Comments
 (0)