rendseq
A python package to facilitate your End-Enriched RNA Sequencing (Rend) data analysis dreams!
Overview
To learn more about RendSeq - eg what it is, what types of questions it can help you solve and how you can generate your own RendSeq data set please visit the Li lab website, or check out the Li Lab's 2018 Cell Paper by Lalanne et al.
Installation
To get started - install our package via pip
pip install rendseq
To learn more about how to use this package -please check out our documentation page. (built by Quarto)
We also have example notebooks which can be accessed in the "example notebooks" subfolder". This folder also includes some example data to see proper formatting and to play around with. These example notebooks can also be viewed on our [documentation page]().
Contribute
We welcome collaborators on this project! To get started check out our instructions for how to get started as a contributor.
You can also direct all correspondence about this project to our dedicated mailing list: rendseq at mit dot edu
Our Documentation
Documentation which explains how this package works and also all the included functions, with example code can be found at our Github Pages site
Our docs are made with Quarto and hosted on Github Pages.
In order to update the docs yourself this is what you need to do:
- Install Quarto.
- Install quartodocs.
- Run
quartodoc buildin the docs folder. - Run
quarto renderin the docs folder.
To add new functions so that they are rendered and included in the docs - add them to the quartodoc section in the _quarto.yml file. The docstrings will then be added and processed automatically.
Github pages then treats the docs\ folder as the source for the Github Pages website.
Hopefully the above ^ will be integrated into a Github action soon, but in the meantime this should work fine.