SOM_Seq_Sim: Documentation & Walkthroughs

Welcome to SOM_Seq_Sim’s documentation! Within this webpage, you can find a summary of our repo, an overview of our data, multiple Jupyter Notebook tutorials, information for contributing to the project, and descriptions of the core functions within the program.

Each function is also added to an alphabetical index, available at the bottom of this page.

Project Overview

• SOM-Seq
  • Installation
  • Quick Start
  • CLI Reference
  • Documentation
  • Testing
  • Contributing
  • Citation
  • License
• Data Overview
• Core Function Descriptions
  • SOM Core Functions
  • Seq_Sim Core Functions

Setup & Walkthroughs

• Installation Instructions
• Generating Sequencing Data
• Creating SOMs
  • Using the Command-Line Interface
• Inputs
  • Required Inputs
  • Optional Inputs
• Usage
  • Hyperparameter Tuning
  • Direct SOM Fitting
• Outputs
  • Metrics
  • Visualizations
  • Writing Your Own Script
• Walkthroughs
  • Seq Sim Workflow
  • SOM Example Iris
  • SOM Example Seq
  • SOM Example Titanic

Resources

• References & Acknowledgements
• Link to Github
• Contributing to SOM_Seq_Sim
  • Table of Contents
  • Code of Conduct
  • I Have a Question
  • I Want To Contribute
  • Style Guides
  • Code Quality
  • Attribution
• Code of Conduct - SOM_Seq_Sim
  • Our Pledge
  • Our Standards
  • Our Responsibilities
  • Scope
  • Enforcement
  • Attribution

Indices and tables

• Index

• Module Index

• Search Page