Long Ranger1.3, printed on 12/26/2024
Long Ranger algorithms are tuned and optimized for human haplotype phasing and structural variant calling, and 10x Genomics provides pre-built hg19 and b37-style reference packages for use with the pipeline. The pre-built references have the following characteristics:
Use of the pre-built references is strongly recommended unless you have specific requirements that match one of the compatible use cases below:
Long Ranger supports the use of customer-generated references for the following scenarios:
The following scenarios are not currently supported by Long Ranger:
There are 3 steps to construct a Long Ranger-compatible reference. You must have version 1.1.1 or later of both Long Ranger and Loupe.
To create a reference, run the longranger mkref command on your FASTA file. The contigs in your FASTA must meet the compatibility requirements above.
$ longranger mkref hsapiens-asm19.fasta ... indexing may take over an hour ... $ ls refdata-hsapiens-asm19 fasta/ genes/ genome regions/ snps/
This utility copies your FASTA, indexes it in several formats, and outputs a folder named refdata-<fasta_name>.
At this point, the reference folder created by longranger mkref is usable by Long Ranger, but it is strongly recommended that you also include a region blacklist for structural variant calling.
For hg19 references, we provide pre-built blacklist files that you can simply copy into your reference. Follow the instructions below, depending on the naming convention of your reference:
hg19 Convention ("chr1")
$ cd refdata-hsapiens-asm19 $ cd regions $ wget https://cf.10xgenomics.com/supp/genome/hg19/sv_blacklist.bed $ wget https://cf.10xgenomics.com/supp/genome/hg19/segdups.bedpe
b37 Convention ("1")
$ cd refdata-hsapiens-asm19 $ cd regions $ wget https://cf.10xgenomics.com/supp/genome/b37/sv_blacklist.bed $ wget https://cf.10xgenomics.com/supp/genome/b37/segdups.bedpe
For all other references, follow these instructions to create custom blacklist files.
To enable the display of the genes and exons tracks in the Loupe genome browser, download our genes and exons file into your reference. This file will work regardless of the naming convention of your reference.
$ cd refdata-hsapiens-asm19 $ cd genes $ wget https://cf.10xgenomics.com/supp/genome/loupe_genes_exons.tsv
This step is optional, but if you omit this file, you will not be able to search by gene name in Loupe, or see the genes and exons tracks in the Loupe Haplotype view. Please note that modifying this file is not supported.
If you have followed the steps above correctly, your reference folder should now contain the following files:
$ tree refdata-hsapiens-asm19 refdata-hsapiens-asm19/ ├── fasta │ ├── genome.fa │ ├── genome.fa.amb │ ├── genome.fa.ann │ ├── genome.fa.bwt │ ├── genome.fa.fai │ ├── genome.fa.flat │ ├── genome.fa.gdx │ ├── genome.fa.pac │ └── genome.fa.sa ├── genes │ └── loupe_genes_exons.tsv ├── genome ├── regions │ ├── segdups.bedpe │ └── sv_blacklist.bed └── snps 4 directories, 13 files
To run Long Ranger with your new reference, set the --reference argument of longranger run to your new reference:
$ longranger run --reference=/path/to/refdata-hsapiens-asm19 ...