Skip to content

In-Sight Documentation

In-Sight is a Python toolkit for genomic and read-level visualization.

This documentation is organized for two audiences:

  • Users You want to install the project, run commands, render plots, and customize R layouts when needed.
  • Developers You want to understand the framework, reuse the base pipeline, and build scenario-specific applications on top of it.

What You Can Do Here

  • Learn how to install and use plot2insights as a unified command-line entrypoint.
  • Understand how bundled R scripts power different plotting layouts.
  • Override built-in R scripts with your own custom visualization code.
  • Study three real command implementations as framework examples:
  • in_sight/commands/bayesmonstr2insights.py
  • in_sight/commands/cf2insights.py
  • in_sight/commands/plot2insights.py
  • in_sight/commands/scrna2insights.py

If you are a user:

  1. Read Getting Started.
  2. Read plot2insights.
  3. Read Scenario Commands if you need the specialized apps.

If you are a developer:

  1. Read Framework Architecture.
  2. Read Command Reference Patterns.
  3. Read Build Scenario Apps.
  4. Read Build Your Python Project Documentation With MkDocs.