Logo

Overview

  • Installation
  • Quickstart
    • XChrom quick start guide
  • Files and directories

Tutorials

  • Tutorials
    • 1. Within-sample analysis
    • 2. Cross-sample analysis
    • 3. Cross-species analysis
    • 4. COVID-19 analysis
    • 5. Pretrained XChrom

API

  • API
    • xchrom.readfile.read_10x_h5_to_h5ad
    • xchrom.pp.process_train_test_single
    • xchrom.pp.process_test_dual
    • xchrom.pp.filter_multiome_data
    • xchrom.tr.train_XChrom
    • xchrom.tr.Generator
    • xchrom.tr.XChrom_model
    • xchrom.tl.calc_auc_pr
    • xchrom.tl.calc_nsls_score
    • xchrom.tl.calc_pca
    • xchrom.tl.bed_to_fasta
    • xchrom.tl.crosscell_aucprc
    • xchrom.tl.crosscell_nsls
    • xchrom.tl.crosspeak_aucprc
    • xchrom.tl.crossboth_aucprc
    • xchrom.tl.denoise_nsls
    • xchrom.tl.crosssamples_aucprc
    • xchrom.tl.crosssamples_nsls
    • xchrom.tl.calc_ism
    • xchrom.tl.ism_norm
    • xchrom.tl.calc_ism_from_bed
    • xchrom.tl.generate_tf_activity_data
    • xchrom.tl.calc_tf_activity
    • xchrom.pl.plot_train_history
    • xchrom.pl.plot_logo
    • xchrom.pl.plot_percell_aucprc
    • xchrom.pl.plot_perpeak_aucprc
    • xchrom.pl.plot_motif_activity
XChrom
  • Tutorials
  • View page source

Tutorials

Examples data

Some processed files have been uploaded to Zenodo (DOI: https://doi.org/10.5281/zenodo.16959682) for direct use. Others can be obtained via the download links provided in this tutorial.

Major tutorials

  • 1. Within-sample analysis
    • 1. Download data (mouse brain)
    • 2. Read and filter data
    • 3. Process scRNA-seq data to generate raw cell embeddings
    • 4. Training/test data prepare
    • 5. Train XChrom
    • 6. Evaluate the Model Performance
  • 2. Cross-sample analysis
    • 1. Download Data (BMMCs: s1d1-s2d1)
    • 2. Read and filter data
    • 3. Process scRNA-seq data to generate raw cell embeddings (2 samples batch correction)
    • 4. Training/test data prepare
    • 5. Train XChrom
    • 6. Evaluate model performance in cross-sample scenario
  • 3. Cross-species analysis
    • 1. Download Data (Human: m1d1, Mouse: mop3c2)
    • 2. Read and filter data
    • 3. Training/test data prepare
    • 4. Train XChrom
    • 5. Evaluate model performance in cross-species scenario
    • 6. Calculate ISM
    • 7. Calculate PWM-ISM dot product
  • 4. COVID-19 analysis
    • 1. Download Data (PBMC10k, COVID-19)
    • 2. Training/test data prepare
    • 3. Train the model
    • 4. Calculate TF activity
    • 5. Check TF activity in different cell types
  • 5. Pretrained XChrom
    • 1. Download data and pretrained model
    • 2. Map the new scRNA-seq sample to the reference RNA embedding space
    • 3. Predict chromatin accessibility for the new sample
    • 4. Evaluate the cell-state structure of predicted accessibility
    • 5. Calculate transcription factor activity
Previous Next

© Copyright 2025, Yuanyuan Miao. Last updated on 2026-09-19.

Built with Sphinx using a theme provided by Read the Docs.