Metadata-Version: 2.1
Name: rdat-kit
Version: 1.6.1
Summary: RDATKit is a utility library for reading and writing RDAT files that describe RNA structure mapping experiments
Author-email: Das Lab <thedaslab@stanford.edu>
Project-URL: Homepage, https://github.com/ribokit/rdatkit
Project-URL: Documentation, https://rmdb.stanford.edu/rdatkit
Project-URL: Bug Tracker, https://github.com/ribokit/rdatkit/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# RDATKit (RNA Dataset ToolKIT)

**RDATkit** is a set of tools for parsing, analyzing, and publishing data of RNA chemical footprinting assays. It allows researchers to share their data using community standard formats, and helps them publish their results on indexable and shareable databases.

**RDATKit** is a package provides a set of *Python* and *MATLAB* scripts that facilitate saving and loading data to and from files with **RDAT** format. It also supports the **ISATAB** file format.


## Installation

#### MATLAB

- Download the zip or tar file of the repository and unpack; or 
```bash
git clone https://github.com/ribokit/RDATKit.git
```

- In *MATLAB*, go to "**Set Path**". Then "**Add with Subfolders**" of the target `path/to/RDATKit/MATLAB/`.

#### Python

To install **RDATKit**, simply:

```bash
pip install rdat_kit
```

**RDATKit** requires the following *Python* packages as dependencies, all of which can be installed through [`pip`](https://pip.pypa.io/).
```json
numpy >= 1.8.0
scipy >= 0.13.0
xlrd >= 0.9.2
xlwt >= 1.0.0
```

## Documentation

Documentation is available at https://ribokit.github.io/RDATKit/.

## License

Copyright &copy; of **RDATKit** _Source Code_ is described in [LICENSE.md](https://github.com/ribokit/RDATKit/blob/master/LICENSE.md).

<hr/>

Developed by [**Das lab**](https://daslab.stanford.edu), _Leland Stanford Junior University_.
