Metadata-Version: 2.1
Name: rdat-kit
Version: 1.6.0
Summary: RDATKit is a utility library for reading and writing RDAT files that describe RNA structure mapping experiments
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
Author-email: Das Lab <thedaslab@stanford.edu>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# 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:

- Copy `path.py.example` into `rdatkit/path.py`. Edit `rdatkit/path.py` following the instructions in the file to point to local installations of `RNAstructure`, `ViennaRNA`, and `VARNA`.

- Run:
```bash
cd path/to/RDATKit/
python setup.py install
```

For system-wide installation, you must have permissions and use with `sudo`.

**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**, _Leland Stanford Junior University_.

README by [**t47**](http://t47.io/), *March 2016*.
