Spl-IsoQuant manual

Spl-IsoQuant is a forked version of IsoQuant developed for spatial long-read data analysis.

Quick start:

Spl-IsoQuant can be downloaded from https://github.com/algbio/spl-IsoQuant
You will need Python3 (3.8 or higher), gffutils, pysam, pybedtools, biopython and some other common Python libraries to be installed. See requirements.txt for details. You will also need to have minimap2 and samtools to be in your $PATH variable.
Verify your installation by running:
```
splisoquant.py --test
```

To run IsoQuant on raw FASTQ/FASTA files use the following command

splisoquant.py --reference /PATH/TO/reference_genome.fasta \
--genedb /PATH/TO/gene_annotation.gtf \
--fastq /PATH/TO/data.fastq.gz \
--barcode_whitelist /PATH/TO/barcodes.tsv \
--data_type (pacbio_ccs|nanopore) -o OUTPUT_FOLDER

For example, using the toy data provided within this repository

    splisoquant.py --reference tests/splisoseq/GRCh38.chrX.fa.gz \
    --genedb tests/splisoseq/ref.gtf --complete_genedb \
    --fastq tests/splisoseq/ONT.fasta.gz --barcode_whitelist tests/splisoseq/barcodes.tsv.gz \
    -d ont -p TEST -o splisoseq_test

About Spl-IsoQuant

Spl-IsoQuant is a tool for the genome-based analysis of spatial long RNA reads obtained with Spl-ISO-Seq protocol. It supports both PacBio and Oxford Nanopore sequencing data. Spl-IsoQuant performs barcode detection, read-to-isoform assignment, quantification and PCR deduplication.

Spl-IsoQuant is released under GPLv2 on June 12th, 2024 and can be downloaded from https://github.com/algbio/spl-IsoQuant.

Supported data types

Spl-IsoQuant supports long-read RNA sequencing data (PacBio CCS, ONT cDNA/dRNA) obtained with Spl-Iso-Seq protocol. It also supports bulk long-read data.

Reads must be provided in FASTQ or FASTA format (can be gzipped). If you have already aligned your reads to the reference genome, simply provide sorted and indexed BAM files.

IsoQuant can also take aligned Illumina reads to correct long-read spliced alignments. However, short reads are not used to discover transcript models or compute abundances.

Supported reference data

Reference genome should be provided in multi-FASTA format (can be gzipped). Reference genome is mandatory even when BAM files are provided.

Reference gene annotation is not mandatory, but is likely to increase precision and recall. It can be provided in GFF/GTF format (can be gzipped). In this case it will be converted to gffutils database. Information on converted databases will be stored in your ~/.config/IsoQuant/db_config.json to increase speed of future runs. You can also provide gffutils database manually. Make sure that chromosome/scaffold names are identical in FASTA file and gene annotation. Note, that gffutils databases may not work correctly on NFS shares. It is possible to set a designated folder for the database with --genedb_output (different from the output directory).

Pre-constructed aligner index can also be provided to increase mapping time.

Installation

Spl-IsoQuant requires a 64-bit Linux system or Mac OS and Python (3.8 and higher) to be pre-installed on it. There are no specific hardware requirements.

You will also need

Installation and requirements

To obtain Spl-IsoQuant you can download repository and install requirements.
Clone Spl-IsoQuant repository and switch to the latest release:

git clone https://github.com/algbio/spl-IsoQuant
cd spl-IsoQuant

Install requirements:

pip install -r requirements.txt

You also need samtools 1.14+ and minimap2 2.18+ to be in the $PATH variable. Alternatively, you can install all dependencies via conda by installing original IsoQuant:

Spl-IsoQuant was tested with version given in the requirements.txt. It was also tested with minimap2 2.18, 2.22 and 2.24, samtools 1.14.

conda create -c conda-forge -c bioconda -n isoquant python=3.8 isoquant

Typical installation takes no more than a few minutes.

Verifying your installation

To verify Spl-IsoQuant installation type

splisoquant.py --test

to run on toy dataset.
If the installation is successful, you will find the following information at the end of the log:

=== Spl-IsoQuant pipeline finished ===
=== TEST PASSED CORRECTLY ===

Running on the test data requires no more than a few minutes.

Running Spl-IsoQuant

Spl-IsoQuant input

To run Spl-IsoQuant, you should provide:

Long RNA reads (PacBio or Oxford Nanopore) in one of the following formats:
- FASTA/FASTQ (can be gzipped);
- Sorted and indexed BAM;
Reference sequence in FASTA format (can be gzipped);
Reference gene annotation in gffutils database or GTF/GFF format (can be gzipped).

Specifying input data via command line

Two main options are --fastq and --bam (see description below). Both options accept one or multiple files separated by space. All provided files are treated as a single experiment, which means a single combined GTF will be generated. If multiple files are provided, Spl-IsoQuant will compute tables with each column corresponding to an individual file (per-sample counts). To set a specific label for each sample use the --label option. Number of labels must be equal to the number of files. To a set a prefix for the output files use the --prefix option.

This pipeline is typical for the cases when a user is interested in comparing expression between different replicas/conditions within the same experiment.

Spl-IsoQuant command line options

Basic options

--output (or -o) Output folder, will be created automatically.

Note: if your output folder is located on a shared disk, use --genedb_output for storing reference annotation database.

--help (or -h) Prints help message.

--test Runs Spl-IsoQuant on the toy data set.

Input options

--data_type or -d Type of data to process, supported values are: pacbio_ccs (same as pacbio), nanopore (same as ont) and assembly (same as transcripts). This option affects the algorithm parameters.

--reference or -r Reference genome in FASTA format (can be gzipped), required even when BAM files are provided.

--index Reference genome index for the specified aligner (minimap2 by default), can be provided only when raw reads are used as an input (constructed automatically if not set).

--genedb or -g Gene database in gffutils database format or GTF/GFF format (can be gzipped). If you use official gene annotations we recommend to set --complete_genedb option.

--complete_genedb Set this flag if gene annotation contains transcript and gene meta-features. Use this flag when providing official annotations, e.g. GENCODE. This option will set disable_infer_transcripts and disable_infer_genes gffutils options, which dramatically speeds up gene database conversion (see more here).

Providing input reads via command line option:

--fastq Input FASTQ/FASTA file(s), can be gzipped; a single GTF will be generated for all files. If multiple files are provided, expression tables with "per-file" columns will be computed. See more about input data.

--bam Sorted and indexed BAM file(s); a single GTF will be generated for all files. If multiple files are provided, expression tables with "per-file" columns will be computed. See more about input data.

--barcode_whitelist A file with a list of possible barcodes (one per line).

--barcoded_reads A TSV files containing read ids in the first column and their corresponding barcodes in the second column. Column that contains the barcodes can be modified using --barcode_column. Column indices start from 0.

--barcode_column A index of the column that contains barcodes in the TSV file specified by the --barcoded_reads (default is 1). Column indices are 0-based.

Other input options:

--stranded Reads strandness type, supported values are: forward, reverse, none.

--fl_data Input sequences represent full-length transcripts; both ends of the sequence are considered to be reliable.

--prefix or -p Prefix for all output files and sub-folder name. OUT if not set.

--labels or -l Sets space-separated sample names. Make sure that the number of labels is equal to the number of files. Input file names are used as labels if not set.

Pipeline options

--resume Resume a previously unfinished run. Output folder with previous run must be specified. Allowed options are --threads and --debug, other options cannot be changed. Spl-IsoQuant will run from the beginning if the output folder does not contain the previous run.

--force force to overwrite the folder with previous run.

--threads or -t Number of threads to use, 16 by default.

--clean_start Do not use previously generated gene database, genome indices or BAM files, run pipeline from the very beginning (will take more time).

Hidden options

We recommend not to modify these options unless you are clearly aware of their effect.

--no_gzip Do not compress large output files.

--no_gtf_check Do not perform input GTF checks.

--no_secondary Ignore secondary alignments.

--genedb_output If your output folder is located on a shared storage (e.g. NFS share), use this option to set another path for storing the annotation database, because SQLite database cannot be created on a shared disks. The folder will be created automatically.

--high_memory Cache read alignments instead for making several passes over a BAM file, noticeably increases RAM usage, but may improve running time when disk I/O is relatively slow.

Example

To run Spl-IsoQuant on a simple Spl-Iso-Seq dataset provided within the package, run

    splisoquant.py --reference tests/splisoseq/GRCh38.chrX.fa.gz \
    --genedb tests/splisoseq/ref.gtf --complete_genedb \
    --fastq tests/splisoseq/ONT.fasta.gz --barcode_whitelist tests/splisoseq/barcodes.tsv.gz \
    -d ont -p TEST -o splisoseq_test

Typically, this test takes no more than a few minutes.

As a result, in the splisoseq_test/TEST folder you will get the following files:

TEST_DATA.barcoded_reads_0.tsv - detected barcodes;
TEST_DATA.UMI_filteredED2.UMI_filtered.allinfo - PCR deduplicated reads with barcodes and gene assignemts;
TEST_DATA.UMI_filteredED2.UMI_filtered.reads.tsv - list of PCR deduplicated read idsl
TEST_DATA.UMI_filteredED2.stats.tsv - bried stats for PCR deduplication and read assignments;
TEST_DATA.read_assignments.tsv.gz - read-to-isoform assignments;
TEST_DATA.corrected_reads.bed.gz - read alignments after splice site correction;
TEST_DATA.gene_counts.tsv, TEST_DATA.gene_tpm.tsv - bulk gene counts/TPMs;
TEST_DATA.transcript_counts.tsv, TEST_DATA.transcript_tpm.tsv - bulk gene counts/TPMs;
aux/TEST_DATA_ONT_798f05_d91ab7_5b7995.bam - aligner reads.

Spl-IsoQuant output

Output files

Spl-IsoQuant output files will be stored in <output_dir>, which is set by the user. If the output directory was not specified the files are stored in isoquant_output.

Output files are:

SAMPLE_ID.barcoded_reads_#.tsv - TSV files containing read ids, their respective barcodes and UMIs. A separate files is produced for every input files with reads.
SAMPLE_ID.read_assignments.tsv.gz - TSV file with read to isoform assignments (gzipped by default);
SAMPLE_ID.corrected_reads.bed.gz - BED file with corrected read alignments (gzipped by default);
SAMPLE_ID.transcript_tpm.tsv - TSV file with reference transcript expression in TPM;
SAMPLE_ID.transcript_counts.tsv - TSV file with raw read counts for reference transcript;
SAMPLE_ID.gene_tpm.tsv - TSV file with reference gene expression in TPM;
SAMPLE_ID.gene_counts.tsv - TSV file with raw read counts for reference genes;
SAMPLE_ID.UMI_filteredED2.UMI_filtered.allinfo - a TSV files reads kept after PCR deduplication. It contains all necessary information for downstream Spl-Iso-Seq data analysis, such assigned gene, transcript, barcode, UMI etc.
SAMPLE_ID.UMI_filteredED2.UMI_filtered.reads.tsv - same as above, but contains only read ids.
SAMPLE_ID.UMI_filteredED2.stats.tsv - brief statistics for the PCD deduplication and the resulting TSV files.

Additionally, a log file will be saved to the directory.

<output_dir>/isoquant.log

If raw reads were provided, BAM file(s) will be stored in <output_dir>/<SAMPLE_ID>/aux/.
In case --keep_tmp option was specified this directory will also contain temporary files.

Output file formats

Although most output files include headers that describe the data, a brief explanation of the output files is provided below.

Detected barcodes

read_id - read id;
barcode - detected barcode sequence, * if not detected;
UMI - detected UMI sequence, * if not detected;
BC_score - barcode alignemnt score, -1 if not detected;
valid_UMI - indicates whether UMI has the length similar to expected and has non-T nucleoties at the end (True/False);
strand - read strand (+/-/.)
polyT_start - start position of the poly-T tail (-1 if not detected);
primer_end - end position of the primer (-1 if not detected);
linker_start - start position of the linker splitting the barcodes (-1 if not detected);
linker_end - end position of the linker splitting the barcodes (-1 if not detected);

UMI-filtered reads

read_id - read id;
gene_id - assigned gene id;
cell_type - assigned cell type (None if not assigned);
barcode - detected barcode sequence;
UMI - detected UMI sequence;
exons - exon coordinates;
TSS - transcript start position;
TES - transcript end position;
intons - intron coordinates;
transcript_type - transcript type (known/novel);
exon_num - number of exons;
transcript_id - assigned transcript id;
transcript_type - transcript type derived from the gene annotation;

Read to isoform assignment

Tab-separated values, the columns are:

read_id - read id;
chr - chromosome id;
strand - strand of the assigned isoform (not to be confused with read mapping strand);
isoform_id - isoform id to which the read was assigned;
gene_id - gene id to which the read was assigned;
assignment_type - assignment type, can be:
- unique - reads was unambiguously assigned to a single known isoform;
- unique_minor_difference - read was assigned uniquely but has alignment artifacts;
- inconsistent - read was matched with inconsistencies, closest match(es) are reported;
- ambiguous - read was assigned to multiple isoforms equally well;
- noninfomative - reads is intronic/intergenic.
assignment_events - list of detected inconsistencies; for each assigned isoform a list of detected inconsistencies relative to the respective isoform is stored; values in each list are separated by + symbol, lists are separated by comma, the number of lists equals to the number of assigned isoforms; possible events are (see graphical representation below):
- consistent events:
  - none / . / undefined - no special event detected;
  - mono_exon_match mono-exonic read matched to mono-exonic transcript;
  - fsm - full splice match;
  - ism_5/3 - incomplete splice match, truncated on 5'/3' side;
  - ism_internal - incomplete splice match, truncated on both sides;
  - mono_exonic - mono-exonic read matching spliced isoform;
  - tss_match / tss_match_precise - 5' read is located less than 50 / delta bases from the TSS of the assigned isoform
  - tes_match / tes_match_precise - 3' read is located less than 50 / delta bases from the TES of the assigned isoform (can be reported without detecting polyA sites)
- alignment artifacts:
  - intron_shift - intron that seems to be shifted due to misalignment (typical for Nanopores);
  - exon_misalignment - short exon that seems to be missed due to misalignment (typical for Nanopores);
  - fake_terminal_exon_5/3 - short terminal exon at 5'/3' end that looks like an alignment artifact (typical for Nanopores);
  - terminal_exon_misalignment_5/3 - missed reference short terminal exon;
  - exon_elongation_5/3 - minor exon extension at 5'/3' end (not exceeding 30bp);
  - fake_micro_intron_retention - short annotated introns are often missed by the aligners and thus are not considered as intron retention;
- intron retentions:
  - intron_retention - intron retention;
  - unspliced_intron_retention - intron retention by mono-exonic read;
  - incomplete_intron_retention_5/3 - terminal exon at 5'/3' end partially covers adjacent intron;
- significant inconsistencies (each type end with _known if all resulting read introns are annotated and _novel otherwise):
  - major_exon_elongation_5/3 - significant exon extension at 5'/3' end (exceeding 30bp);
  - extra_intron_5/3 - additional intron on the 5'/3' end of the isoform;
  - extra_intron - read contains additional intron in the middle of exon;
  - alt_donor_site - read contains alternative donor site;
  - alt_acceptor_site - read contains alternative annotated acceptor site;
  - intron_migration - read contains alternative annotated intron of approximately the same length as in the isoform;
  - intron_alternation - read contains alternative intron, which doesn't fall intro any of the categories above;
  - mutually_exclusive_exons - read contains different exon(s) of the same total length comparing to the isoform;
  - exon_skipping - read skips exon(s) comparing to the isoform;
  - exon_merge - read skips exon(s) comparing to the isoform, but a sequence of a similar length is attached to a neighboring exon;
  - exon_gain - read contains additional exon(s) comparing to the isoform;
  - exon_detach - read contains additional exon(s) comparing to the isoform, but a neighboring exon looses a sequnce of a similar length;
  - terminal_exon_shift - read has alternative terminal exon;
  - alternative_structure - reads has different intron chain that does not fall into any of categories above;
- alternative transcription start / end (reported when poly-A tails are present):
  - alternative_polya_site - read has alternative polyadenylation site;
  - internal_polya_site - poly-A tail detected but seems to be originated from A-rich intronic region;
  - correct_polya_site - poly-A site matches reference transcript end;
  - aligned_polya_tail - poly-A tail aligns to the reference;
  - alternative_tss - alternative transcription start site.
exons - list of coordinates for normalized read exons (1-based, indels and polyA exons are excluded);
additional - field for supplementary information, which may include:
- PolyA - True if poly-A tail is detected;
- Canonical - True if all read introns are canonical, Unspliced is used for mono-exon reads; (use --check_canonical)

Note, that a single read may occur more than once if assigned ambiguously.

Expression table format

Tab-separated values, the columns are:

feature_id - genomic feature ID;
TPM or count - expression value (float).

For grouped counts, each column contains expression values of a respective group.

Citation

The manuscript is currently under preparation.

Feedback and bug reports

Your comments, bug reports, and suggestions are very welcome. They will help us to further improve Spl-IsoQuant. If you have any troubles running Spl-IsoQuant, please send us isoquant.log from the <output_dir> directory.

You can leave your comments and bug reports at our GitHub repository tracker.