Documentation

Comprehensive guide to the RNAlytics project, providing detailed insights into our bioinformatics pipeline and analysis workflows.

Last updated: March 2024
For researchers & developers

Project Setup

Prerequisites

  • ๐Ÿ
    Python 3.8+
  • ๐Ÿ’ป
    Node.js 18+
  • ๐Ÿ”„
    Git

Installation

# Clone the repository
git clone https://github.com/aryehky/RNAlytics.git

# Install Python dependencies
python -m venv venv
source venv/bin/activate  # or 'venv\Scripts\activate' on Windows
pip install -r requirements.txt

# Install Node.js dependencies
npm install

Project Structure

project-root/
โ”œโ”€โ”€ app/                 # Next.js pages
โ”œโ”€โ”€ components/          # React components
โ”œโ”€โ”€ data/               # Data files
โ”‚   โ”œโ”€โ”€ raw/            # Raw datasets
โ”‚   โ””โ”€โ”€ processed/      # Processed data
โ”œโ”€โ”€ notebooks/          # Jupyter notebooks
โ”œโ”€โ”€ src/                # Source code
โ”‚   โ”œโ”€โ”€ api/            # Backend API
โ”‚   โ””โ”€โ”€ utils/          # Utility functions
โ””โ”€โ”€ tests/              # Test files